Skip to content

Commit

Permalink
Add Repository docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ddebeau committed Aug 26, 2024
1 parent 021e2a2 commit b2d441b
Show file tree
Hide file tree
Showing 5 changed files with 107 additions and 0 deletions.
37 changes: 37 additions & 0 deletions docs/data-sources/repository.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_repository Data Source - quay"
subcategory: ""
description: |-
---

# quay_repository (Data Source)



## Example Usage

```terraform
data "quay_organization" "main" {
name = "main"
}
data "quay_repository" "test" {
name = "test"
namespace = data.quay_organization.main.name
}
```

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

### Required

- `name` (String) Repository name
- `namespace` (String) Repository namespace. Should be an organization name or username

### Read-Only

- `description` (String) Markdown description
- `visibility` (String) Repository visibility. Should be private or public.
49 changes: 49 additions & 0 deletions docs/resources/repository.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "quay_repository Resource - quay"
subcategory: ""
description: |-
---

# quay_repository (Resource)



## Example Usage

```terraform
resource "quay_organization" "main" {
name = "main"
email = "[email protected]"
}
resource "quay_repository" "test" {
name = "test"
namespace = quay_organization.main.name
visibility = "private"
description = "test"
}
```

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

### Required

- `name` (String) Repository name
- `namespace` (String) Repository namespace. Should be an organization name or username

### Optional

- `description` (String) Markdown description
- `visibility` (String) Repository visibility. Should be private or public.

## Import

Import is supported using the following syntax:

```shell
# An organization can be imported using its name.
terraform import quay_repository.test main/test
```
8 changes: 8 additions & 0 deletions examples/data-sources/quay_repository/data-source.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
data "quay_organization" "main" {
name = "main"
}

data "quay_repository" "test" {
name = "test"
namespace = data.quay_organization.main.name
}
2 changes: 2 additions & 0 deletions examples/resources/quay_repository/import.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# An organization can be imported using its name.
terraform import quay_repository.test main/test
11 changes: 11 additions & 0 deletions examples/resources/quay_repository/resource.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
resource "quay_organization" "main" {
name = "main"
email = "[email protected]"
}

resource "quay_repository" "test" {
name = "test"
namespace = quay_organization.main.name
visibility = "private"
description = "test"
}

0 comments on commit b2d441b

Please sign in to comment.