Skip to content

Commit

Permalink
docs: run generator (#74)
Browse files Browse the repository at this point in the history
Signed-off-by: Nick Santos <nick.santos@docker.com>
  • Loading branch information
nicks authored Dec 11, 2024
1 parent f618fc9 commit 7ab57cd
Show file tree
Hide file tree
Showing 15 changed files with 412 additions and 34 deletions.
37 changes: 35 additions & 2 deletions docs/data-sources/access_token.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,45 @@
page_title: "docker_access_token Data Source - docker"
subcategory: ""
description: |-
Docker Hub Access Token
Retrieves details of a specific Docker Hub access token by its UUID.
Example Usage
data "docker_hub_access_token" "example" {
uuid = "123e4567-e89b-12d3-a456-426614174000"
}
output "access_token_details" {
value = {
label = data.docker_hub_access_token.example.token_label
scopes = data.docker_hub_access_token.example.scopes
created_at = data.docker_hub_access_token.example.created_at
last_used = data.docker_hub_access_token.example.last_used
is_active = data.docker_hub_access_token.example.is_active
}
}
---

# docker_access_token (Data Source)

Docker Hub Access Token
Retrieves details of a specific Docker Hub access token by its UUID.

## Example Usage

```hcl
data "docker_hub_access_token" "example" {
uuid = "123e4567-e89b-12d3-a456-426614174000"
}
output "access_token_details" {
value = {
label = data.docker_hub_access_token.example.token_label
scopes = data.docker_hub_access_token.example.scopes
created_at = data.docker_hub_access_token.example.created_at
last_used = data.docker_hub_access_token.example.last_used
is_active = data.docker_hub_access_token.example.is_active
}
}
```



Expand Down
21 changes: 19 additions & 2 deletions docs/data-sources/access_tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,29 @@
page_title: "docker_access_tokens Data Source - docker"
subcategory: ""
description: |-
Docker Hub Access Token
Retrieves the list of Docker Hub access tokens associated with the authenticated user.
Example Usage
data "docker_hub_access_tokens" "example" {}
output "access_token_uuids" {
value = data.docker_hub_access_tokens.example.uuids
}
---

# docker_access_tokens (Data Source)

Docker Hub Access Token
Retrieves the list of Docker Hub access tokens associated with the authenticated user.

## Example Usage

```hcl
data "docker_hub_access_tokens" "example" {}
output "access_token_uuids" {
value = data.docker_hub_access_tokens.example.uuids
}
```



Expand Down
26 changes: 24 additions & 2 deletions docs/data-sources/hub_repositories.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,34 @@
page_title: "docker_hub_repositories Data Source - docker"
subcategory: ""
description: |-
Docker Hub Repositories
Retrieves a list of repositories within a specified Docker Hub namespace.
Example Usage
data "docker_hub_repositories" "example" {
namespace = "my-organization"
max_number_results = 10
}
output "repositories" {
value = data.docker_hub_repositories.example.repository
}
---

# docker_hub_repositories (Data Source)

Docker Hub Repositories
Retrieves a list of repositories within a specified Docker Hub namespace.

## Example Usage

```hcl
data "docker_hub_repositories" "example" {
namespace = "my-organization"
max_number_results = 10
}
output "repositories" {
value = data.docker_hub_repositories.example.repository
}
```



Expand Down
39 changes: 39 additions & 0 deletions docs/data-sources/hub_repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,51 @@
page_title: "docker_hub_repository Data Source - docker"
subcategory: ""
description: |-
Retrieves information about a Docker Hub repository.
~> Note: The repository must already exist in your Docker Hub account or organization.
Example Usage
data "docker_hub_repository" "example" {
namespace = "my-organization"
name = "my-repo"
}
output "repository_info" {
value = {
id = data.docker_hub_repository.example.id
description = data.docker_hub_repository.example.description
full_description = data.docker_hub_repository.example.full_description
private = data.docker_hub_repository.example.private
pull_count = data.docker_hub_repository.example.pull_count
}
}
---

# docker_hub_repository (Data Source)

Retrieves information about a Docker Hub repository.

~> **Note**: The repository must already exist in your Docker Hub account or organization.

## Example Usage

```hcl
data "docker_hub_repository" "example" {
namespace = "my-organization"
name = "my-repo"
}
output "repository_info" {
value = {
id = data.docker_hub_repository.example.id
description = data.docker_hub_repository.example.description
full_description = data.docker_hub_repository.example.full_description
private = data.docker_hub_repository.example.private
pull_count = data.docker_hub_repository.example.pull_count
}
}
```



Expand Down
21 changes: 19 additions & 2 deletions docs/data-sources/login.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,29 @@
page_title: "docker_login Data Source - docker"
subcategory: ""
description: |-
Reads current login info.
Reads the current login information.
Example Usage
data "docker_hub_login" "current" {}
output "current_user" {
value = data.docker_hub_login.current.username
}
---

# docker_login (Data Source)

Reads current login info.
Reads the current login information.

## Example Usage

```hcl
data "docker_hub_login" "current" {}
output "current_user" {
value = data.docker_hub_login.current.username
}
```



Expand Down
41 changes: 37 additions & 4 deletions docs/data-sources/org.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,48 @@
page_title: "docker_org Data Source - docker"
subcategory: ""
description: |-
Reads an organization properties.
~> Note Only available when authenticated with a username and password.
Reads properties of a Docker Hub organization.
~> Note: This data source is only available when authenticated with a username and password.
Example Usage
data "docker_hub_org" "example" {
org_name = "my-organization"
}
output "organization_details" {
value = {
id = data.docker_hub_org.example.id
full_name = data.docker_hub_org.example.full_name
location = data.docker_hub_org.example.location
company = data.docker_hub_org.example.company
date_joined = data.docker_hub_org.example.date_joined
}
}
---

# docker_org (Data Source)

Reads an organization properties.
Reads properties of a Docker Hub organization.

~> **Note** Only available when authenticated with a username and password.
~> **Note**: This data source is only available when authenticated with a username and password.

## Example Usage

```hcl
data "docker_hub_org" "example" {
org_name = "my-organization"
}
output "organization_details" {
value = {
id = data.docker_hub_org.example.id
full_name = data.docker_hub_org.example.full_name
location = data.docker_hub_org.example.location
company = data.docker_hub_org.example.company
date_joined = data.docker_hub_org.example.date_joined
}
}
```



Expand Down
41 changes: 37 additions & 4 deletions docs/data-sources/org_team.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,48 @@
page_title: "docker_org_team Data Source - docker"
subcategory: ""
description: |-
Reads team in an organization.
~> Note Only available when authenticated with a username and password.
Reads team information within a Docker Hub organization.
~> Note: This data source is only available when authenticated with a username and password.
Example Usage
data "docker_hub_org_team" "example" {
org_name = "my-organization"
team_name = "dev-team"
}
output "team_info" {
value = {
id = data.docker_hub_org_team.example.id
uuid = data.docker_hub_org_team.example.uuid
description = data.docker_hub_org_team.example.description
member_count = data.docker_hub_org_team.example.member_count
}
}
---

# docker_org_team (Data Source)

Reads team in an organization.
Reads team information within a Docker Hub organization.

~> **Note** Only available when authenticated with a username and password.
~> **Note**: This data source is only available when authenticated with a username and password.

## Example Usage

```hcl
data "docker_hub_org_team" "example" {
org_name = "my-organization"
team_name = "dev-team"
}
output "team_info" {
value = {
id = data.docker_hub_org_team.example.id
uuid = data.docker_hub_org_team.example.uuid
description = data.docker_hub_org_team.example.description
member_count = data.docker_hub_org_team.example.member_count
}
}
```



Expand Down
40 changes: 36 additions & 4 deletions docs/data-sources/org_team_member.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,47 @@
page_title: "docker_org_team_member Data Source - docker"
subcategory: ""
description: |-
Reads team member of an organization.
~> Note Only available when authenticated with a username and password.
Reads team members of a specified team within a Docker Hub organization.
~> Note: This data source is only available when authenticated with a username and password.
Example Usage
data "docker_hub_org_team_member" "example" {
org_name = "my-organization"
team_name = "dev-team"
}
output "team_members" {
value = data.docker_hub_org_team_member.example.members
}
output "team_member_roles" {
value = [for member in data.docker_hub_org_team_member.example.members : { member = member.username, role = member.role }]
}
```
---

# docker_org_team_member (Data Source)

Reads team member of an organization.
Reads team members of a specified team within a Docker Hub organization.

~> **Note** Only available when authenticated with a username and password.
~> **Note**: This data source is only available when authenticated with a username and password.

## Example Usage

```hcl
data "docker_hub_org_team_member" "example" {
org_name = "my-organization"
team_name = "dev-team"
}
output "team_members" {
value = data.docker_hub_org_team_member.example.members
}
output "team_member_roles" {
value = [for member in data.docker_hub_org_team_member.example.members : { member = member.username, role = member.role }]
}
```
Expand Down
19 changes: 17 additions & 2 deletions docs/resources/access_token.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,27 @@
page_title: "docker_access_token Resource - docker"
subcategory: ""
description: |-
Manages access tokens.
Manages access tokens..
Example Usage
resource "docker_access_token" "example" {
token_label = "my-pat-token"
scopes = ["repo:read", "repo:write"]
}
---

# docker_access_token (Resource)

Manages access tokens.
Manages access tokens..

## Example Usage

```hcl
resource "docker_access_token" "example" {
token_label = "my-pat-token"
scopes = ["repo:read", "repo:write"]
}
```



Expand Down
Loading

0 comments on commit 7ab57cd

Please sign in to comment.