Roles and Permission Management
The Shipa provider for Crossplane allows you to manage roles and permissions assigned to users in Shipa.
Creating Roles
apiVersion: shipa.crossplane.io/v1alpha1
kind: Role
metadata:
name: cross-role-daniel
spec:
forProvider:
name: CrossRoleDanielJr
context: app
Top-Level Attributes
| Component | Type | Description |
|---|---|---|
| apiVersion | string | the version of the API. |
| kind | string | the kind of custom resource that will be created by Shipa. Role is the kind used by Shipa for managing roles. |
| metadata | the name of the custom resource that will be created by Shipa. | |
| spec | the specification that will be used by Shipa when creating the role. |
Metadata
| Component | Type | Description |
|---|---|---|
| name | string | the name of the custom resource that will be created by Shipa. |
Specification
| Component | Type | Description |
|---|---|---|
| name | string | the name of the role to be created. Required: Yes |
| context | string | the context level that should be assigned to the role. Options: - team - app - global / organization - framework Required: Yes |
Assigning Permissions to Roles
apiVersion: shipa.crossplane.io/v1alpha1
kind: Permission
metadata:
name: cp-test-role-assign
spec:
forProvider:
name: cpTestRole
permission: ["app.read", "app.deploy"]
Top-Level Attributes
| Component | Type | Description |
|---|---|---|
| apiVersion | string | the version of the API. |
| kind | string | the kind of custom resource that will be created by Shipa. Permission is the kind used by Shipa for assigning permissions to roles. |
| metadata | the name of the custom resource that will be created by Shipa. | |
| spec | the specification that will be used by Shipa when creating the team. |
Metadata
| Component | Type | Description |
|---|---|---|
| name | string | the name of the custom resource that will be created by Shipa. |
Specification
| Component | Type | Description |
|---|---|---|
| name | string | the name of the existing role permissions should be assigned to. Required: Yes |
| permission | string | the list of permissions that should be assigned to an existing role. you can find a list of available permissions by running the following command from your Shipa CLI: shipa permission list Required: Yes |
Associating Roles to Users
apiVersion: shipa.crossplane.io/v1alpha1
kind: RoleAssociation
metadata:
name: cp-test-role-associate
spec:
forProvider:
name: cpTestRole
email: [email protected]
Top-Level Attributes
| Component | Type | Description |
|---|---|---|
| apiVersion | string | the version of the API. |
| kind | string | the kind of custom resource that will be created by Shipa. RoleAssociation is the kind used by Shipa for associating roles to users. |
| metadata | the name of the custom resource that will be created by Shipa. | |
| spec | the specification that will be used by Shipa when associating roles. |
Metadata
| Component | Type | Description |
|---|---|---|
| name | string | the name of the custom resource that will be created by Shipa. |
Specification
| Component | Type | Description |
|---|---|---|
| name | string | the name of the existing role to be assigned to an existing user. Required: Yes |
| string | the email of an existing user that should have the role assigned to. Required: Yes |
Updated about 1 year ago