Update examples

port-labs · May 20, 2024 · c5632cd · c5632cd
1 parent 1d8afe1
commit c5632cd
Show file tree

Hide file tree

Showing 26 changed files with 815 additions and 395 deletions.
diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@ Port is the Developer Platform meant to supercharge your DevOps and Developers,
 
 ## Documentation
 
-- [Terraform registry docs](https://registry.terraform.io/providers/port-labs/port/latest/docs)
+- [Terraform registry docs](https://registry.terraform.io/providers/port-labs/port-labs/latest/docs)
 - [Port docs](https://docs.getport.io/build-your-software-catalog/sync-data-to-catalog/iac/terraform)
 
 ## Requirements
@@ -30,7 +30,7 @@ terraform {
   required_providers {
     port = {
       source  = "port-labs/port-labs"
-      version = "~> 1.0.0"
+      version = "~> 2.0.0"
     }
   }
 }
@@ -49,4 +49,4 @@ terraform init
 
 ## Examples
 
-please refer to the [examples](./examples) directory
+Please refer to the [examples](./examples) directory
diff --git a/docs/resources/port_action_permissions.md b/docs/resources/port_action_permissions.md
@@ -8,22 +8,22 @@ description: |-
   Example Usage
   hcl
   resource "port_action_permissions" "restart_microservice_permissions" {
-    action_identifier = port_action.restart_microservice.identifier
-    permissions = {
-      "execute" : {
-        "roles" : [
-          "Admin"
-        ],
-        "users" : [],
-        "teams" : [],
-        "owned_by_team" : true
-      },
-      "approve" : {
-        "roles" : ["Member", "Admin"],
-        "users" : [],
-        "teams" : []
+      action_identifier = port_action.restart_microservice.identifier
+      permissions = {
+          "execute" : {
+              "roles" : [
+                  "admin"
+              ],
+              "users" : [],
+              "teams" : [],
+              "owned_by_team" : true
+          },
+          "approve" : {
+              "roles" : ["member", "admin"],
+              "users" : [],
+              "teams" : []
+          }
       }
-    }
   }
   
   Example Usage with Policy
@@ -78,7 +78,29 @@ description: |-
   }
   ```
   Disclaimer
-  Action permissions are created by default when creating a new action, this means that you should use this resource when you want to change the default permissions of an action.When deleting an action permissions resource using terraform, the action permissions will not be deleted from Port, as they are required for the action to work, instead, the action permissions will be removed from the terraform state.
+  Action permissions are created by default when creating a new action, this means that you should use this resource when you want to change the default permissions of an action.When deleting an action permissions resource using terraform, the action permissions will not be deleted from Port, as they are required for the action to work, instead, the action permissions will be removed from the terraform state.All the permission lists (roles, users, teams) are managed by Port in a sorted manner, this means that if your .tf has for example roles defined out of order, your state will be invalid
+  E.g:
+  hcl
+  resource "port_action_permissions" "restart_microservice_permissions" {
+      action_identifier = port_action.restart_microservice.identifier
+      permissions = {
+          # invalid
+          "execute" : {
+              "roles" : [
+                  "member",
+                  "admin",
+              ],
+              ...
+          },
+          # valid
+          "approve" : {
+              "roles" : [
+                  "admin",
+                  "member",
+              ],
+          }
+      }
+  }
 ---
 
 # port_action_permissions (Resource)
@@ -91,22 +113,22 @@ Docs for the Action Permissions resource can be found [here](https://docs.getpor
 
 ```hcl
 resource "port_action_permissions" "restart_microservice_permissions" {
-  action_identifier = port_action.restart_microservice.identifier
-  permissions = {
-    "execute" : {
-      "roles" : [
-        "Admin"
-      ],
-      "users" : [],
-      "teams" : [],
-      "owned_by_team" : true
-    },
-    "approve" : {
-      "roles" : ["Member", "Admin"],
-      "users" : [],
-      "teams" : []
-    }
-  }
+	action_identifier = port_action.restart_microservice.identifier
+	permissions = {
+		"execute" : {
+			"roles" : [
+				"admin"
+			],
+			"users" : [],
+			"teams" : [],
+			"owned_by_team" : true
+		},
+		"approve" : {
+			"roles" : ["member", "admin"],
+			"users" : [],
+			"teams" : []
+		}
+	}
 }
 ```
 
@@ -166,10 +188,35 @@ resource "port_action_permissions" "restart_microservice_permissions" {
 }
 ```
 
-## Disclaimer 
+## Disclaimer
 
 - Action permissions are created by default when creating a new action, this means that you should use this resource when you want to change the default permissions of an action.
 - When deleting an action permissions resource using terraform, the action permissions will not be deleted from Port, as they are required for the action to work, instead, the action permissions will be removed from the terraform state.
+- All the permission lists (roles, users, teams) are managed by Port in a sorted manner, this means that if your `.tf` has for example roles defined out of order, your state will be invalid
+    E.g:
+
+    ```hcl
+	resource "port_action_permissions" "restart_microservice_permissions" {
+		action_identifier = port_action.restart_microservice.identifier
+		permissions = {
+			# invalid
+			"execute" : {
+				"roles" : [
+					"member",
+					"admin",
+				],
+				...
+			},
+			# valid
+			"approve" : {
+				"roles" : [
+					"admin",
+					"member",
+				],
+			}
+		}
+	}
+```