From 80461753e95dfbf130df4c6ef1cb751f8d169712 Mon Sep 17 00:00:00 2001 From: David Debeau Date: Fri, 2 Aug 2024 11:50:46 -0500 Subject: [PATCH] Add docs --- docs/data-sources/organization.md | 30 +++++++++++++++++++++++++ docs/index.md | 32 ++++++++++++++++++++++++++ docs/resources/organization.md | 37 +++++++++++++++++++++++++++++++ 3 files changed, 99 insertions(+) create mode 100644 docs/data-sources/organization.md create mode 100644 docs/index.md create mode 100644 docs/resources/organization.md diff --git a/docs/data-sources/organization.md b/docs/data-sources/organization.md new file mode 100644 index 0000000..445022e --- /dev/null +++ b/docs/data-sources/organization.md @@ -0,0 +1,30 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "quay_organization Data Source - quay" +subcategory: "" +description: |- + +--- + +# quay_organization (Data Source) + + + +## Example Usage + +```terraform +data "quay_organization" "main" { + name = "main" +} +``` + + +## Schema + +### Required + +- `name` (String) Organization name + +### Read-Only + +- `email` (String) Organization contact email diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..8ba932b --- /dev/null +++ b/docs/index.md @@ -0,0 +1,32 @@ +--- +page_title: "Quay Provider" +subcategory: "" +description: |- + Terraform provider for the [Quay Project](https://github.com/quay/quay). +--- + +# Quay Provider +The Quay provider provides resources and data sources for managing Quay organizations and repositories. + +## Authentication +An authentication token can be generated in the Quay application settings page. The Quay documentation refers to it as +an `OAuth 2 Access Token`. Since there is no mechanism in Quay for creating applications outside of an organization, it +is recommended to create a separate organization and application for Terraform. Be sure to create the +`OAuth 2 Access Token` using a service account since the token will be tied to that account. + +## Example Usage + +```terraform +provider "quay" { + url = "https://quay.example.com" +} +``` + + +## Schema + +### Optional + +- `token` (String, Sensitive) Quay token. May also be provided via the QUAY_TOKEN environment variable. +- `url` (String) Quay URL. May also be provided via the QUAY_URL environment variable. Example: https://quay.example.com + diff --git a/docs/resources/organization.md b/docs/resources/organization.md new file mode 100644 index 0000000..091ed55 --- /dev/null +++ b/docs/resources/organization.md @@ -0,0 +1,37 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "quay_organization Resource - quay" +subcategory: "" +description: |- + +--- + +# quay_organization (Resource) + + + +## Example Usage + +```terraform +resource "quay_organization" "main" { + name = "main" + email = "quay+main@example.com" +} +``` + + +## Schema + +### Required + +- `email` (String) Organization contact email +- `name` (String) Organization name + +## Import + +Import is supported using the following syntax: + +```shell +# An organization can be imported using its name. +terraform import quay_organization.main main +```