Skip to content

Commit

Permalink
Add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ddebeau committed Aug 2, 2024
1 parent aac1402 commit 8046175
Show file tree
Hide file tree
Showing 3 changed files with 99 additions and 0 deletions.
30 changes: 30 additions & 0 deletions docs/data-sources/organization.md
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: "quay_organization Data Source - quay"
subcategory: ""
description: |-
---

# quay_organization (Data Source)



## Example Usage

```terraform
data "quay_organization" "main" {
name = "main"
}
```

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

### Required

- `name` (String) Organization name

### Read-Only

- `email` (String) Organization contact email
32 changes: 32 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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 generated by tfplugindocs -->
## 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

37 changes: 37 additions & 0 deletions docs/resources/organization.md
Original file line number Diff line number Diff line change
@@ -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 = "[email protected]"
}
```

<!-- schema generated by tfplugindocs -->
## 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
```

0 comments on commit 8046175

Please sign in to comment.