From 649188cfac434cc9033a8fb5bba1496412bac23b Mon Sep 17 00:00:00 2001 From: David Debeau Date: Wed, 28 Aug 2024 10:44:54 -0500 Subject: [PATCH] Update documentation and examples --- docs/data-sources/organization_robot.md | 38 ++++++++++++++ docs/data-sources/organization_team.md | 49 +++++++++++++++++++ .../quay_organization_robot/data-source.tf | 9 ++++ .../quay_organization_team/data-source.tf | 19 +++++++ 4 files changed, 115 insertions(+) create mode 100644 docs/data-sources/organization_robot.md create mode 100644 docs/data-sources/organization_team.md create mode 100644 examples/data-sources/quay_organization_robot/data-source.tf create mode 100644 examples/data-sources/quay_organization_team/data-source.tf diff --git a/docs/data-sources/organization_robot.md b/docs/data-sources/organization_robot.md new file mode 100644 index 0000000..b613d92 --- /dev/null +++ b/docs/data-sources/organization_robot.md @@ -0,0 +1,38 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "quay_organization_robot Data Source - quay" +subcategory: "" +description: |- + +--- + +# quay_organization_robot (Data Source) + + + +## Example Usage + +```terraform +resource "quay_organization" "org" { + name = "org" + email = "quay+org@example.com" +} + +data "quay_organization_robot" "robot" { + name = "robot" + orgname = quay_organization.org.name +} +``` + + +## Schema + +### Required + +- `name` (String) Robot short name +- `orgname` (String) Organization name + +### Read-Only + +- `description` (String) Text description +- `fullname` (String) Robot full name diff --git a/docs/data-sources/organization_team.md b/docs/data-sources/organization_team.md new file mode 100644 index 0000000..bd9955f --- /dev/null +++ b/docs/data-sources/organization_team.md @@ -0,0 +1,49 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "quay_organization_team Data Source - quay" +subcategory: "" +description: |- + +--- + +# quay_organization_team (Data Source) + + + +## Example Usage + +```terraform +resource "quay_organization" "org" { + name = "org" + email = "quay+org@example.com" +} + +resource "quay_repository" "repo" { + name = "repo" + namespace = quay_organization.org.name +} + +resource "quay_organization_robot" "robot" { + name = "robot" + orgname = quay_organization.org.name +} + +data "quay_organization_team" "team" { + name = "team" + orgname = quay_organization.org.name +} +``` + + +## Schema + +### Required + +- `name` (String) Team name +- `orgname` (String) Organization name + +### Read-Only + +- `description` (String) Markdown description +- `members` (List of String) List of team members +- `role` (String) Team role diff --git a/examples/data-sources/quay_organization_robot/data-source.tf b/examples/data-sources/quay_organization_robot/data-source.tf new file mode 100644 index 0000000..3c45431 --- /dev/null +++ b/examples/data-sources/quay_organization_robot/data-source.tf @@ -0,0 +1,9 @@ +resource "quay_organization" "org" { + name = "org" + email = "quay+org@example.com" +} + +data "quay_organization_robot" "robot" { + name = "robot" + orgname = quay_organization.org.name +} diff --git a/examples/data-sources/quay_organization_team/data-source.tf b/examples/data-sources/quay_organization_team/data-source.tf new file mode 100644 index 0000000..4cc44b1 --- /dev/null +++ b/examples/data-sources/quay_organization_team/data-source.tf @@ -0,0 +1,19 @@ +resource "quay_organization" "org" { + name = "org" + email = "quay+org@example.com" +} + +resource "quay_repository" "repo" { + name = "repo" + namespace = quay_organization.org.name +} + +resource "quay_organization_robot" "robot" { + name = "robot" + orgname = quay_organization.org.name +} + +data "quay_organization_team" "team" { + name = "team" + orgname = quay_organization.org.name +}