-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(role-jaas): add docs for jaas' roles
- Loading branch information
1 parent
e65476c
commit 4afaf97
Showing
12 changed files
with
138 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "juju_jaas_role Data Source - terraform-provider-juju" | ||
subcategory: "" | ||
description: |- | ||
A data source representing a Juju JAAS Role. | ||
--- | ||
|
||
# juju_jaas_role (Data Source) | ||
|
||
A data source representing a Juju JAAS Role. | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
data "juju_jaas_role" "test" { | ||
name = "role-0" | ||
} | ||
output "role_uuid" { | ||
value = data.juju_jaas_role.test.uuid | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `name` (String) The name of the role. | ||
|
||
### Read-Only | ||
|
||
- `uuid` (String) The UUID of the role. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "juju_jaas_access_role Resource - terraform-provider-juju" | ||
subcategory: "" | ||
description: |- | ||
A resource that represents access to a role when using JAAS. | ||
--- | ||
|
||
# juju_jaas_access_role (Resource) | ||
|
||
A resource that represents access to a role when using JAAS. | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
resource "juju_jaas_access_role" "development" { | ||
role_id = juju_jaas_role.target-role.uuid | ||
access = "member" | ||
users = ["[email protected]"] | ||
roles = [juju_jaas_role.development.uuid] | ||
service_accounts = ["Client-ID-1", "Client-ID-2"] | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `access` (String) Level of access to grant. Changing this value will replace the Terraform resource. Valid access levels are described at https://canonical-jaas-documentation.readthedocs-hosted.com/en/latest/reference/authorisation_model/#valid-relations | ||
- `role_id` (String) The ID of the role for access management. If this is changed the resource will be deleted and a new resource will be created. | ||
|
||
### Optional | ||
|
||
- `groups` (Set of String) List of groups to grant access. | ||
- `service_accounts` (Set of String) List of service accounts to grant access. | ||
- `users` (Set of String) List of users to grant access. | ||
|
||
### Read-Only | ||
|
||
- `id` (String) The ID of this resource. | ||
|
||
## Import | ||
|
||
Import is supported using the following syntax: | ||
|
||
```shell | ||
# JAAS role access can be imported using the role UUID and access level | ||
$ terraform import juju_jaas_access_role.development UUID:member | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "juju_jaas_role Resource - terraform-provider-juju" | ||
subcategory: "" | ||
description: |- | ||
A resource that represents a role in JAAS | ||
--- | ||
|
||
# juju_jaas_role (Resource) | ||
|
||
A resource that represents a role in JAAS | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
resource "juju_jaas_role" "development" { | ||
name = "devops-team" | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `name` (String) Name of the role | ||
|
||
### Read-Only | ||
|
||
- `uuid` (String) UUID of the role |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
data "juju_jaas_role" "test" { | ||
name = "role-0" | ||
} | ||
|
||
output "role_uuid" { | ||
value = data.juju_jaas_role.test.uuid | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# JAAS role access can be imported using the role UUID and access level | ||
$ terraform import juju_jaas_access_role.development UUID:member |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
resource "juju_jaas_access_role" "development" { | ||
role_id = juju_jaas_role.target-role.uuid | ||
access = "member" | ||
users = ["[email protected]"] | ||
roles = [juju_jaas_role.development.uuid] | ||
service_accounts = ["Client-ID-1", "Client-ID-2"] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
resource "juju_jaas_role" "development" { | ||
name = "devops-team" | ||
} |