Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add resource descriptions #6

Merged
merged 1 commit into from
Oct 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/data-sources/armada_armada.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "ec_armada_armada Data Source - terraform-provider-ec"
subcategory: ""
description: |-

Use this data source to access information about an existing Armada.
---

# ec_armada_armada (Data Source)


Use this data source to access information about an existing Armada.



Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/armada_armada_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "ec_armada_armada_v1 Data Source - terraform-provider-ec"
subcategory: ""
description: |-

Use this data source to access information about an existing Armada.
---

# ec_armada_armada_v1 (Data Source)


Use this data source to access information about an existing Armada.



Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/armada_armadaset.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "ec_armada_armadaset Data Source - terraform-provider-ec"
subcategory: ""
description: |-

Use this data source to access information about an existing ArmadaSet.
---

# ec_armada_armadaset (Data Source)


Use this data source to access information about an existing ArmadaSet.



Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/armada_armadaset_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "ec_armada_armadaset_v1 Data Source - terraform-provider-ec"
subcategory: ""
description: |-

Use this data source to access information about an existing ArmadaSet.
---

# ec_armada_armadaset_v1 (Data Source)


Use this data source to access information about an existing ArmadaSet.



Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/armada_branch.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "ec_armada_branch Data Source - terraform-provider-ec"
subcategory: ""
description: |-

Use this data source to access information about an existing Branch.
---

# ec_armada_branch (Data Source)


Use this data source to access information about an existing Branch.



Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/armada_branch_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "ec_armada_branch_v1 Data Source - terraform-provider-ec"
subcategory: ""
description: |-

Use this data source to access information about an existing Branch.
---

# ec_armada_branch_v1 (Data Source)


Use this data source to access information about an existing Branch.



Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/armada_region.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "ec_armada_region Data Source - terraform-provider-ec"
subcategory: ""
description: |-

Use this data source to access information about an existing Region.
---

# ec_armada_region (Data Source)


Use this data source to access information about an existing Region.



Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/armada_region_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "ec_armada_region_v1 Data Source - terraform-provider-ec"
subcategory: ""
description: |-

Use this data source to access information about an existing Region.
---

# ec_armada_region_v1 (Data Source)


Use this data source to access information about an existing Region.



Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/armada_site.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "ec_armada_site Data Source - terraform-provider-ec"
subcategory: ""
description: |-

Use this data source to access information about an existing Site.
---

# ec_armada_site (Data Source)


Use this data source to access information about an existing Site.



Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/armada_site_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "ec_armada_site_v1 Data Source - terraform-provider-ec"
subcategory: ""
description: |-

Use this data source to access information about an existing Site.
---

# ec_armada_site_v1 (Data Source)


Use this data source to access information about an existing Site.



Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,4 @@ resource "ec_armada_site" "test" {
- `host` (String) The hostname (in form of URI) of Armada API.
- `password` (String) The password to authenticate with.
- `token_endpoint` (String) The URI to the token authentication endpoint.
- `username` (String) The user to authenticate with.
- `username` (String) The user to authenticate with.
4 changes: 2 additions & 2 deletions docs/resources/armada_armada.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "ec_armada_armada Resource - terraform-provider-ec"
subcategory: ""
description: |-

An Armada distributes a specified number of Game Servers across a Region.
---

# ec_armada_armada (Resource)


An Armada distributes a specified number of Game Servers across a Region.



Expand Down
4 changes: 2 additions & 2 deletions docs/resources/armada_armada_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "ec_armada_armada_v1 Resource - terraform-provider-ec"
subcategory: ""
description: |-

An Armada distributes a specified number of Game Servers across a Region.
---

# ec_armada_armada_v1 (Resource)


An Armada distributes a specified number of Game Servers across a Region.



Expand Down
4 changes: 2 additions & 2 deletions docs/resources/armada_armadaset.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "ec_armada_armadaset Resource - terraform-provider-ec"
subcategory: ""
description: |-

An ArmadaSet manages Armadas across multiple Regions, while sharing a common specification.
---

# ec_armada_armadaset (Resource)


An ArmadaSet manages Armadas across multiple Regions, while sharing a common specification.



Expand Down
4 changes: 2 additions & 2 deletions docs/resources/armada_armadaset_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "ec_armada_armadaset_v1 Resource - terraform-provider-ec"
subcategory: ""
description: |-

An ArmadaSet manages Armadas across multiple Regions, while sharing a common specification.
---

# ec_armada_armadaset_v1 (Resource)


An ArmadaSet manages Armadas across multiple Regions, while sharing a common specification.



Expand Down
15 changes: 14 additions & 1 deletion docs/resources/armada_branch.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,27 @@
page_title: "ec_armada_branch Resource - terraform-provider-ec"
subcategory: ""
description: |-

A Branch groups container Images.
---

# ec_armada_branch (Resource)

A Branch groups container Images.

## Example Usage

```terraform
resource "ec_armada_branch" "test" {
metadata {
name = "test"
}

spec {
description = "My branch"
display_name = "Test"
}
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
15 changes: 14 additions & 1 deletion docs/resources/armada_branch_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,27 @@
page_title: "ec_armada_branch_v1 Resource - terraform-provider-ec"
subcategory: ""
description: |-

A Branch groups container Images.
---

# ec_armada_branch_v1 (Resource)

A Branch groups container Images.

## Example Usage

```terraform
resource "ec_armada_branch_v1" "test" {
metadata {
name = "test"
}

spec {
description = "My branch"
display_name = "Test"
}
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
4 changes: 2 additions & 2 deletions docs/resources/armada_region.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "ec_armada_region Resource - terraform-provider-ec"
subcategory: ""
description: |-

A Region determines how Armadas are distributed across Sites.
---

# ec_armada_region (Resource)


A Region determines how Armadas are distributed across Sites.



Expand Down
4 changes: 2 additions & 2 deletions docs/resources/armada_region_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "ec_armada_region_v1 Resource - terraform-provider-ec"
subcategory: ""
description: |-

A Region determines how Armadas are distributed across Sites.
---

# ec_armada_region_v1 (Resource)


A Region determines how Armadas are distributed across Sites.



Expand Down
4 changes: 2 additions & 2 deletions docs/resources/armada_site.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "ec_armada_site Resource - terraform-provider-ec"
subcategory: ""
description: |-

A Site provides a connection to deployment capacity.
---

# ec_armada_site (Resource)


A Site provides a connection to deployment capacity.

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/resources/armada_site_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "ec_armada_site_v1 Resource - terraform-provider-ec"
subcategory: ""
description: |-

A Site provides a connection to deployment capacity.
---

# ec_armada_site_v1 (Resource)


A Site provides a connection to deployment capacity.

## Example Usage

Expand Down
1 change: 1 addition & 0 deletions ec/armada/data_source_armada_armada.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (
// DataSourceArmadaArmada returns the data source resource for an Armada.
func DataSourceArmadaArmada() *schema.Resource {
return &schema.Resource{
Description: "Use this data source to access information about an existing Armada.",
ReadContext: dataSourceArmadaArmadaRead,
Schema: armadaSchema(),
}
Expand Down
1 change: 1 addition & 0 deletions ec/armada/data_source_armada_armadaset.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (
// DataSourceArmadaArmadaSet returns the data source resource for an ArmadaSet.
func DataSourceArmadaArmadaSet() *schema.Resource {
return &schema.Resource{
Description: "Use this data source to access information about an existing ArmadaSet.",
ReadContext: dataSourceArmadaArmadaSetRead,
Schema: armadaSetSchema(),
}
Expand Down
1 change: 1 addition & 0 deletions ec/armada/data_source_armada_branch.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (
// DataSourceArmadaBranch returns the data source resource for a Branch.
func DataSourceArmadaBranch() *schema.Resource {
return &schema.Resource{
Description: "Use this data source to access information about an existing Branch.",
ReadContext: dataSourceArmadaBranchRead,
Schema: branchSchema(),
}
Expand Down
1 change: 1 addition & 0 deletions ec/armada/data_source_armada_region.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (
// DataSourceArmadaRegion returns the data source resource for a Region.
func DataSourceArmadaRegion() *schema.Resource {
return &schema.Resource{
Description: "Use this data source to access information about an existing Region.",
ReadContext: dataSourceArmadaRegionRead,
Schema: regionSchema(),
}
Expand Down
1 change: 1 addition & 0 deletions ec/armada/data_source_armada_site.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (
// DataSourceArmadaSite returns the data source resource for a Site.
func DataSourceArmadaSite() *schema.Resource {
return &schema.Resource{
Description: "Use this data source to access information about an existing Site.",
ReadContext: dataSourceArmadaSiteRead,
Schema: siteSchema(),
}
Expand Down
1 change: 1 addition & 0 deletions ec/armada/resource_armada_armada.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import (
// ResourceArmadaArmada returns the resource for an Armada.
func ResourceArmadaArmada() *schema.Resource {
return &schema.Resource{
Description: "An Armada distributes a specified number of Game Servers across a Region.",
ReadContext: resourceArmadaArmadaRead,
CreateContext: resourceArmadaArmadaCreate,
UpdateContext: resourceArmadaArmadaUpdate,
Expand Down
1 change: 1 addition & 0 deletions ec/armada/resource_armada_armadaset.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import (
// ResourceArmadaArmadaSet returns the resource for an ArmadaSet.
func ResourceArmadaArmadaSet() *schema.Resource {
return &schema.Resource{
Description: "An ArmadaSet manages Armadas across multiple Regions, while sharing a common specification.",
ReadContext: resourceArmadaArmadaSetRead,
CreateContext: resourceArmadaArmadaSetCreate,
UpdateContext: resourceArmadaArmadaSetUpdate,
Expand Down
1 change: 1 addition & 0 deletions ec/armada/resource_armada_branch.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import (
// ResourceArmadaBranch returns the resource for a Branch.
func ResourceArmadaBranch() *schema.Resource {
return &schema.Resource{
Description: "A Branch groups container Images.",
ReadContext: resourceArmadaBranchRead,
CreateContext: resourceArmadaBranchCreate,
UpdateContext: resourceArmadaBranchUpdate,
Expand Down
Loading
Loading