Skip to content

Commit

Permalink
Update documentation and examples
Browse files Browse the repository at this point in the history
  • Loading branch information
ddebeau committed Aug 28, 2024
1 parent 5aa3aa6 commit 84b0d8b
Show file tree
Hide file tree
Showing 6 changed files with 153 additions and 1 deletion.
50 changes: 50 additions & 0 deletions docs/data-sources/organization_team_permission.md
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: "quay_organization_team_permission Data Source - quay"
subcategory: ""
description: |-
---

# quay_organization_team_permission (Data Source)



## Example Usage

```terraform
resource "quay_organization" "org" {
name = "org"
email = "[email protected]"
}
resource "quay_repository" "repo" {
name = "repo"
namespace = quay_organization.org.name
}
resource "quay_organization_team" "team" {
name = "team"
orgname = quay_organization.org.name
role = "member"
}
data "quay_organization_team_permission" "permission" {
orgname = quay_organization.org.name
reponame = quay_repository.repo.name
teamname = quay_organization_team.team.name
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `orgname` (String) Organization name
- `reponame` (String) Repository name
- `teamname` (String) Team name

### Read-Only

- `permission` (String) Team permission
2 changes: 1 addition & 1 deletion docs/resources/organization_team.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ resource "quay_organization_team" "admin" {

- `name` (String) Team name
- `orgname` (String) Organization name
- `role` (String) Team permission. Should be admin, creator, or member.
- `role` (String) Team role. Should be admin, creator, or member.

### Optional

Expand Down
57 changes: 57 additions & 0 deletions docs/resources/organization_team_permission.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "quay_organization_team_permission Resource - quay"
subcategory: ""
description: |-
---

# quay_organization_team_permission (Resource)



## Example Usage

```terraform
resource "quay_organization" "org" {
name = "org"
email = "[email protected]"
}
resource "quay_repository" "repo" {
name = "repo"
namespace = quay_organization.org.name
}
resource "quay_organization_team" "team" {
name = "team"
orgname = quay_organization.org.name
role = "member"
}
resource "quay_organization_team_permission" "permission" {
orgname = quay_organization.org.name
reponame = quay_repository.repo.name
teamname = quay_organization_team.team.name
permission = "read"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `orgname` (String) Organization name
- `permission` (String) Team permission. Should be read, write or admin.
- `reponame` (String) Repository name
- `teamname` (String) Team name

## Import

Import is supported using the following syntax:

```shell
# An organization team permission can be imported using the corresponding organization, repository and team name.
terraform import quay_organization_team_permission.permission org repo team
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
resource "quay_organization" "org" {
name = "org"
email = "[email protected]"
}

resource "quay_repository" "repo" {
name = "repo"
namespace = quay_organization.org.name
}

resource "quay_organization_team" "team" {
name = "team"
orgname = quay_organization.org.name
role = "member"
}

data "quay_organization_team_permission" "permission" {
orgname = quay_organization.org.name
reponame = quay_repository.repo.name
teamname = quay_organization_team.team.name
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# An organization team permission can be imported using the corresponding organization, repository and team name.
terraform import quay_organization_team_permission.permission org repo team
22 changes: 22 additions & 0 deletions examples/resources/quay_organization_team_permission/resource.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
resource "quay_organization" "org" {
name = "org"
email = "[email protected]"
}

resource "quay_repository" "repo" {
name = "repo"
namespace = quay_organization.org.name
}

resource "quay_organization_team" "team" {
name = "team"
orgname = quay_organization.org.name
role = "member"
}

resource "quay_organization_team_permission" "permission" {
orgname = quay_organization.org.name
reponame = quay_repository.repo.name
teamname = quay_organization_team.team.name
permission = "read"
}

0 comments on commit 84b0d8b

Please sign in to comment.