chore: regenerate the docs

nitrado · Feb 1, 2024 · 047a26a · 047a26a
1 parent b8b65af
commit 047a26a
Show file tree

Hide file tree

Showing 26 changed files with 86 additions and 3 deletions.
diff --git a/docs/data-sources/armada_armada.md b/docs/data-sources/armada_armada.md
@@ -17,6 +17,7 @@ Use this data source to access information about an existing Armada.
 
 ### Optional
 
+- `instance` (String) Name is an instance name configured in the provider.
 - `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
 - `spec` (Block List, Max: 1) Spec defines the desired armada. (see [below for nested schema](#nestedblock--spec))
 

diff --git a/docs/data-sources/armada_armada_v1.md b/docs/data-sources/armada_armada_v1.md
@@ -17,6 +17,7 @@ Use this data source to access information about an existing Armada.
 
 ### Optional
 
+- `instance` (String) Name is an instance name configured in the provider.
 - `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
 - `spec` (Block List, Max: 1) Spec defines the desired armada. (see [below for nested schema](#nestedblock--spec))
 

diff --git a/docs/data-sources/armada_armadaset.md b/docs/data-sources/armada_armadaset.md
@@ -17,6 +17,7 @@ Use this data source to access information about an existing ArmadaSet.
 
 ### Optional
 
+- `instance` (String) Name is an instance name configured in the provider.
 - `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
 - `spec` (Block List, Max: 1) Spec defines the desired armadas in this set. (see [below for nested schema](#nestedblock--spec))
 

diff --git a/docs/data-sources/armada_armadaset_v1.md b/docs/data-sources/armada_armadaset_v1.md
@@ -17,6 +17,7 @@ Use this data source to access information about an existing ArmadaSet.
 
 ### Optional
 
+- `instance` (String) Name is an instance name configured in the provider.
 - `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
 - `spec` (Block List, Max: 1) Spec defines the desired armadas in this set. (see [below for nested schema](#nestedblock--spec))
 

diff --git a/docs/data-sources/container_branch.md b/docs/data-sources/container_branch.md
@@ -17,6 +17,7 @@ Use this data source to access information about an existing Branch.
 
 ### Optional
 
+- `instance` (String) Name is an instance name configured in the provider.
 - `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
 - `spec` (Block List, Max: 1) Spec defines the desired branch. (see [below for nested schema](#nestedblock--spec))
 

diff --git a/docs/data-sources/container_branch_v1.md b/docs/data-sources/container_branch_v1.md
@@ -17,6 +17,7 @@ Use this data source to access information about an existing Branch.
 
 ### Optional
 
+- `instance` (String) Name is an instance name configured in the provider.
 - `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
 - `spec` (Block List, Max: 1) Spec defines the desired branch. (see [below for nested schema](#nestedblock--spec))
 

diff --git a/docs/data-sources/core_environment.md b/docs/data-sources/core_environment.md
@@ -17,6 +17,7 @@ Use this data source to access information about an existing Environment.
 
 ### Optional
 
+- `instance` (String) Name is an instance name configured in the provider.
 - `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
 - `spec` (Block List, Max: 1) Spec configures the environment. (see [below for nested schema](#nestedblock--spec))
 

diff --git a/docs/data-sources/core_environment_v1.md b/docs/data-sources/core_environment_v1.md
@@ -17,6 +17,7 @@ Use this data source to access information about an existing Environment.
 
 ### Optional
 
+- `instance` (String) Name is an instance name configured in the provider.
 - `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
 - `spec` (Block List, Max: 1) Spec configures the environment. (see [below for nested schema](#nestedblock--spec))
 

diff --git a/docs/data-sources/core_region.md b/docs/data-sources/core_region.md
@@ -17,6 +17,7 @@ Use this data source to access information about an existing Region.
 
 ### Optional
 
+- `instance` (String) Name is an instance name configured in the provider.
 - `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
 - `spec` (Block List, Max: 1) Spec defines the desired region configuration. (see [below for nested schema](#nestedblock--spec))
 

diff --git a/docs/data-sources/core_region_v1.md b/docs/data-sources/core_region_v1.md
@@ -17,6 +17,7 @@ Use this data source to access information about an existing Region.
 
 ### Optional
 
+- `instance` (String) Name is an instance name configured in the provider.
 - `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
 - `spec` (Block List, Max: 1) Spec defines the desired region configuration. (see [below for nested schema](#nestedblock--spec))
 

diff --git a/docs/data-sources/core_site.md b/docs/data-sources/core_site.md
@@ -17,6 +17,7 @@ Use this data source to access information about an existing Site.
 
 ### Optional
 
+- `instance` (String) Name is an instance name configured in the provider.
 - `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
 - `spec` (Block List, Max: 1) Spec defines the desired site configuration. (see [below for nested schema](#nestedblock--spec))
 

diff --git a/docs/data-sources/core_site_v1.md b/docs/data-sources/core_site_v1.md
@@ -17,6 +17,7 @@ Use this data source to access information about an existing Site.
 
 ### Optional
 
+- `instance` (String) Name is an instance name configured in the provider.
 - `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
 - `spec` (Block List, Max: 1) Spec defines the desired site configuration. (see [below for nested schema](#nestedblock--spec))
 

diff --git a/docs/index.md b/docs/index.md
@@ -23,7 +23,11 @@ terraform {
 }
 
 provider "ec" {
-  host = "<your armada host url>"
+  host = "<your enterprise console host url>"
+  instances {
+    name = "my-other-instance"
+    host = "<your enterprise console host url>"
+  }
 }
 
 resource "ec_core_site" "test" {
@@ -41,6 +45,23 @@ resource "ec_core_site" "test" {
     }
   }
 }
+
+resource "ec_core_site" "test2" {
+  instance = "my-other-instance"
+  metadata {
+    name = "test"
+  }
+
+  spec {
+    description = "My other test"
+    credentials {
+      endpoint    = "<your endpoint>"
+      certificate = "<your cert>"
+      namespace   = "<your ns>"
+      token       = "<your token>"
+    }
+  }
+}
 ```
 
 <!-- schema generated by tfplugindocs -->
@@ -50,7 +71,24 @@ resource "ec_core_site" "test" {
 
 - `client_id` (String) The oAuth2 client id to authenticate against.
 - `client_secret` (String) The oAuth2 client secret to authenticate against.
-- `host` (String) The hostname (in form of URI) of Armada API.
+- `host` (String) The hostname (in form of URI) of the Enterprise Console API.
+- `instances` (Block List) Named Enterprise Console instances. (see [below for nested schema](#nestedblock--instances))
+- `password` (String) The password to authenticate with.
+- `token_endpoint` (String) The URI to the token authentication endpoint.
+- `username` (String) The user to authenticate with.
+
+<a id="nestedblock--instances"></a>
+### Nested Schema for `instances`
+
+Required:
+
+- `client_id` (String) The oAuth2 client id to authenticate against.
+- `host` (String) The hostname (in form of URI) of the Enterprise Console API.
+- `name` (String) The instance name.
+
+Optional:
+
+- `client_secret` (String) The oAuth2 client secret to authenticate against.
 - `password` (String) The password to authenticate with.
 - `token_endpoint` (String) The URI to the token authentication endpoint.
 - `username` (String) The user to authenticate with.
diff --git a/docs/resources/armada_armada.md b/docs/resources/armada_armada.md
@@ -17,6 +17,7 @@ An Armada distributes a specified number of Game Servers across a Region.
 
 ### Optional
 
+- `instance` (String) Name is an instance name configured in the provider.
 - `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
 - `spec` (Block List, Max: 1) Spec defines the desired armada. (see [below for nested schema](#nestedblock--spec))
 

diff --git a/docs/resources/armada_armada_v1.md b/docs/resources/armada_armada_v1.md
@@ -17,6 +17,7 @@ An Armada distributes a specified number of Game Servers across a Region.
 
 ### Optional
 
+- `instance` (String) Name is an instance name configured in the provider.
 - `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
 - `spec` (Block List, Max: 1) Spec defines the desired armada. (see [below for nested schema](#nestedblock--spec))
 

diff --git a/docs/resources/armada_armadaset.md b/docs/resources/armada_armadaset.md
@@ -17,6 +17,7 @@ An ArmadaSet manages Armadas across multiple Regions, while sharing a common spe
 
 ### Optional
 
+- `instance` (String) Name is an instance name configured in the provider.
 - `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
 - `spec` (Block List, Max: 1) Spec defines the desired armadas in this set. (see [below for nested schema](#nestedblock--spec))
 

diff --git a/docs/resources/armada_armadaset_v1.md b/docs/resources/armada_armadaset_v1.md
@@ -17,6 +17,7 @@ An ArmadaSet manages Armadas across multiple Regions, while sharing a common spe
 
 ### Optional
 
+- `instance` (String) Name is an instance name configured in the provider.
 - `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
 - `spec` (Block List, Max: 1) Spec defines the desired armadas in this set. (see [below for nested schema](#nestedblock--spec))
 

diff --git a/docs/resources/container_branch.md b/docs/resources/container_branch.md
@@ -30,6 +30,7 @@ resource "ec_container_branch" "test" {
 
 ### Optional
 
+- `instance` (String) Name is an instance name configured in the provider.
 - `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
 - `spec` (Block List, Max: 1) Spec defines the desired branch. (see [below for nested schema](#nestedblock--spec))
 

diff --git a/docs/resources/container_branch_v1.md b/docs/resources/container_branch_v1.md
@@ -30,6 +30,7 @@ resource "ec_container_branch_v1" "test" {
 
 ### Optional
 
+- `instance` (String) Name is an instance name configured in the provider.
 - `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
 - `spec` (Block List, Max: 1) Spec defines the desired branch. (see [below for nested schema](#nestedblock--spec))
 

diff --git a/docs/resources/core_environment.md b/docs/resources/core_environment.md
@@ -17,6 +17,7 @@ An Environment provides a mechanism to isolate groups of resources.
 
 ### Optional
 
+- `instance` (String) Name is an instance name configured in the provider.
 - `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
 - `spec` (Block List, Max: 1) Spec configures the environment. (see [below for nested schema](#nestedblock--spec))
 

diff --git a/docs/resources/core_environment_v1.md b/docs/resources/core_environment_v1.md
@@ -17,6 +17,7 @@ An Environment provides a mechanism to isolate groups of resources.
 
 ### Optional
 
+- `instance` (String) Name is an instance name configured in the provider.
 - `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
 - `spec` (Block List, Max: 1) Spec configures the environment. (see [below for nested schema](#nestedblock--spec))
 

diff --git a/docs/resources/core_region.md b/docs/resources/core_region.md
@@ -17,6 +17,7 @@ A Region determines how Armadas are distributed across Sites.
 
 ### Optional
 
+- `instance` (String) Name is an instance name configured in the provider.
 - `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
 - `spec` (Block List, Max: 1) Spec defines the desired region configuration. (see [below for nested schema](#nestedblock--spec))
 

diff --git a/docs/resources/core_region_v1.md b/docs/resources/core_region_v1.md
@@ -17,6 +17,7 @@ A Region determines how Armadas are distributed across Sites.
 
 ### Optional
 
+- `instance` (String) Name is an instance name configured in the provider.
 - `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
 - `spec` (Block List, Max: 1) Spec defines the desired region configuration. (see [below for nested schema](#nestedblock--spec))
 

diff --git a/docs/resources/core_site.md b/docs/resources/core_site.md
@@ -35,6 +35,7 @@ resource "ec_core_site" "test" {
 
 ### Optional
 
+- `instance` (String) Name is an instance name configured in the provider.
 - `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
 - `spec` (Block List, Max: 1) Spec defines the desired site configuration. (see [below for nested schema](#nestedblock--spec))
 

diff --git a/docs/resources/core_site_v1.md b/docs/resources/core_site_v1.md
@@ -35,6 +35,7 @@ resource "ec_core_site" "test" {
 
 ### Optional
 
+- `instance` (String) Name is an instance name configured in the provider.
 - `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
 - `spec` (Block List, Max: 1) Spec defines the desired site configuration. (see [below for nested schema](#nestedblock--spec))
 

diff --git a/examples/provider/provider.tf b/examples/provider/provider.tf
@@ -9,7 +9,11 @@ terraform {
 }
 
 provider "ec" {
-  host = "<your armada host url>"
+  host = "<your enterprise console host url>"
+  instances {
+    name = "my-other-instance"
+    host = "<your enterprise console host url>"
+  }
 }
 
 resource "ec_core_site" "test" {
@@ -27,3 +31,20 @@ resource "ec_core_site" "test" {
     }
   }
 }
+
+resource "ec_core_site" "test2" {
+  instance = "my-other-instance"
+  metadata {
+    name = "test"
+  }
+
+  spec {
+    description = "My other test"
+    credentials {
+      endpoint    = "<your endpoint>"
+      certificate = "<your cert>"
+      namespace   = "<your ns>"
+      token       = "<your token>"
+    }
+  }
+}