-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2aeca5a
commit db4fd9a
Showing
14 changed files
with
499 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "ogc_project Data Source - ogc" | ||
subcategory: "" | ||
description: |- | ||
--- | ||
|
||
# ogc_project (Data Source) | ||
|
||
|
||
|
||
|
||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Optional | ||
|
||
- `display_name` (String) | ||
- `name` (String) | ||
|
||
### Read-Only | ||
|
||
- `id` (String) The ID of this resource. |
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "ogc_application Resource - ogc" | ||
subcategory: "" | ||
description: |- | ||
Applications are groups of one or more containers, with shared resources such as networking and storage, that can be deployed and replicated across clusters or in a single cluster. | ||
--- | ||
|
||
# ogc_application (Resource) | ||
|
||
Applications are groups of one or more containers, with shared resources such as networking and storage, that can be deployed and replicated across clusters or in a single cluster. | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
resource "ogc_package" "pkg" { | ||
name = "example" | ||
project_id = "0e145a36-1ee7-434c-9f30-9e1ba4da2d7c" | ||
} | ||
resource "ogc_application" "app" { | ||
name = "example" | ||
package_id = ogc_package.pkg.id | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `package_id` (String) The id of the parent Package of the Application. | ||
|
||
### Optional | ||
|
||
- `display_name` (String) The user-supplied name of the Application. | ||
- `fs_group` (Number) Supplemental group that applies to all containers in a pod. | ||
- `max_instances` (Number) The maximum number of cross-cluster instances (Default = 1) of this application to deploy. 0 value has special meaning as noted in the Multiplicity section below. | ||
- `min_instances` (Number) The minimum number of cross-cluster instances of this application to deploy. | ||
- `min_ready_seconds` (Number) Setting for minReadySeconds on all Kubernetes Deployments which are generated by this Application. | ||
- `name` (String) The user-supplied RFC 1123-compliant name of the Application. | ||
- `progress_deadline_seconds` (Number) Setting for progressDeadlineSeconds on all Kubernetes Deployments which are generated by this Application. | ||
- `reject_privileged_clusters` (Boolean) If true the planning algorithm will refuse to place the application on a Cluster for which permitPrivilegedContainers is true. Prevents owned Clusters setting privilegedAccess to true. | ||
- `replicas` (Number) The number of replicas of the Application to be deployed to a single Cluster. | ||
- `requires_redeploy` (Boolean) Set to true if the Application needs the entire owning Package to be redeployed when the Application is restarted for stability reasons. | ||
- `selector` (Block List) An Application may have zero or more Selectors associated with it. These Selectors are used during deployment planning to select which clusters the application can run on. (see [below for nested schema](#nestedblock--selector)) | ||
|
||
### Read-Only | ||
|
||
- `id` (String) The unique identifier of the Application. | ||
- `last_updated` (String) The timestamp of the last change to this entity and any sub-entities. | ||
|
||
<a id="nestedblock--selector"></a> | ||
### Nested Schema for `selector` | ||
|
||
Required: | ||
|
||
- `key` (String) The key that is used to match the key property of a Label. | ||
|
||
Optional: | ||
|
||
- `operator` (String) The SelectorOp used as part of the label matching operation. Can be one of: Exists, NotExists, Equals, NotEquals, In, NotIn, MinOf, MaxOf. Defaults to In. | ||
- `values` (List of String) The values to be used during deployment planning. If operator is Exists, NotExists, MinOf or MaxOf this should be empty. | ||
|
||
Read-Only: | ||
|
||
- `id` (String) The unique identifier of the Selector. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "ogc_container Resource - ogc" | ||
subcategory: "" | ||
description: |- | ||
A Container entity encapsulates all the information required to run an OCI-compliant container image. | ||
--- | ||
|
||
# ogc_container (Resource) | ||
|
||
A Container entity encapsulates all the information required to run an OCI-compliant container image. | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
resource "ogc_container" "container" { | ||
name = "example" | ||
application_id = ogc_application.app.id | ||
image_name = "nginx" | ||
env { | ||
name = "PORT" | ||
value = "80" | ||
} | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `application_id` (String) The id of the parent Application of the Container. | ||
- `image_name` (String) The name of the OCI container image in the associated ImageRegistry. | ||
|
||
### Optional | ||
|
||
- `args` (String) The arguments to pass to the command to execute in the Container as a single string to be tokenised at deployment. | ||
- `command` (String) The command to execute in the Container. | ||
- `display_name` (String) The user-supplied name of the Container. | ||
- `env` (Block List) List of environment variables to set in the container as key/value pairs. (see [below for nested schema](#nestedblock--env)) | ||
- `image_registry_id` (String) The id of the associated ImageRegistry of the Application. | ||
- `image_tag` (String) The tag of the OCI container image in the associated ImageRegistry. | ||
- `name` (String) The user-supplied RFC 1123-compliant name of the Container. | ||
- `privileged_access` (Boolean) If true the container will be deployed in privileged access mode. Cannot be true if the owning Application's rejectPrivilegedClusters property is true or the owning Project's permitPrivilegedContainers property is false. | ||
|
||
### Read-Only | ||
|
||
- `id` (String) The unique identifier of the Container. | ||
- `last_updated` (String) The timestamp of the last change to this entity and any sub-entities. | ||
|
||
<a id="nestedblock--env"></a> | ||
### Nested Schema for `env` | ||
|
||
Required: | ||
|
||
- `name` (String) Name of the environment variable. | ||
|
||
Optional: | ||
|
||
- `secret_id` (String) Secret to be used as value for the environment variable. | ||
- `value` (String) Value of the environment variable. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "ogc_container_mount Resource - ogc" | ||
subcategory: "" | ||
description: |- | ||
Zero or more Mounts may be attached to a container to allow external drive-type content to be requested and assigned. | ||
--- | ||
|
||
# ogc_container_mount (Resource) | ||
|
||
Zero or more Mounts may be attached to a container to allow external drive-type content to be requested and assigned. | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
resource "ogc_container_mount" "mount" { | ||
container_id = ogc_container.container.id | ||
filepath = "/mnt" | ||
storage_request_id = ogc_storage_request.sr.id | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `container_id` (String) The id of the parent Container of the Mount. | ||
- `filepath` (String) Mount point on the container where the requested resource is to be mounted. | ||
|
||
### Optional | ||
|
||
- `access_mode` (String) Required access mode to be applied for access to a Volume generated with a StorageRequest. Only applicable if the type is StorageRequest. | ||
- `secret_id` (String) Secret to be mounted. | ||
- `storage_request_id` (String) Storage Request to be mounted. | ||
- `value` (String) Value to be mounted. | ||
|
||
### Read-Only | ||
|
||
- `id` (String) The unique identifier of the ContainerMount. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "ogc_container_port Resource - ogc" | ||
subcategory: "" | ||
description: |- | ||
Network port exposed by a container. | ||
--- | ||
|
||
# ogc_container_port (Resource) | ||
|
||
Network port exposed by a container. | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
resource "ogc_container_port" "port" { | ||
display_name = "http" | ||
container_id = ogc_container.container.id | ||
internal = 80 | ||
external = 80 | ||
protocol = "TCP" | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `container_id` (String) The id of the parent Container of the Port. | ||
- `display_name` (String) The user-supplied name of the Container. | ||
- `external` (Number) Port to be exposed externally where traffic will come from. | ||
- `internal` (Number) Port within the container the traffic will be published on. | ||
|
||
### Optional | ||
|
||
- `family` (String) The address family the port will listen on. | ||
- `protocol` (String) The IP Protocol the port listens on . | ||
|
||
### Read-Only | ||
|
||
- `id` (String) The unique identifier of the Port. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "ogc_container_resource_request Resource - ogc" | ||
subcategory: "" | ||
description: |- | ||
The ResourceRequest entity encapsulates an individual Containers requirements for a given resource. The content and use of these entities maps directly to the Kubernetes container resource limits, and in the same manner a ResourceRequest has a request property and a limit property. | ||
--- | ||
|
||
# ogc_container_resource_request (Resource) | ||
|
||
The ResourceRequest entity encapsulates an individual Containers requirements for a given resource. The content and use of these entities maps directly to the Kubernetes container resource limits, and in the same manner a ResourceRequest has a request property and a limit property. | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
resource "ogc_container_resource_request" "rr" { | ||
container_id = ogc_container.container.id | ||
resource_type = "memory" | ||
request = "1Gi" | ||
limit = "1Gi" | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `container_id` (String) The id of the parent Container of the Resource Request. | ||
- `limit` (String) The maximum amount of resource to be consumed. | ||
- `request` (String) The amount of resource requested. | ||
- `resource_type` (String) The kubernetes-reported name of the resource to request. | ||
|
||
### Read-Only | ||
|
||
- `id` (String) The unique identifier of the ContainerResourceRequest. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "ogc_package Resource - ogc" | ||
subcategory: "" | ||
description: |- | ||
Packages are the smallest deployable unit in OGC. Packages can have one or more applications that can be connected between themselves through route policies. Applications within a single package may be deployed across multiple clusters. Package selectors decide which clusters will be selected during deployment planning. | ||
--- | ||
|
||
# ogc_package (Resource) | ||
|
||
Packages are the smallest deployable unit in OGC. Packages can have one or more applications that can be connected between themselves through route policies. Applications within a single package may be deployed across multiple clusters. Package selectors decide which clusters will be selected during deployment planning. | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
resource "ogc_package" "pkg" { | ||
name = "example" | ||
project_id = "0e145a36-1ee7-434c-9f30-9e1ba4da2d7c" | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `project_id` (String) The id of the parent Project. | ||
|
||
### Optional | ||
|
||
- `display_name` (String) The user-supplied name of the Package. | ||
- `name` (String) The user-supplied RFC 1123-compliant name of the Package. | ||
- `selector` (Block List) A Package may have zero or more Selectors associated with it. These Selectors apply to all Applications in the Package during deployment planning. (see [below for nested schema](#nestedblock--selector)) | ||
|
||
### Read-Only | ||
|
||
- `id` (String) The unique identifier of the Package. | ||
- `last_updated` (String) The timestamp of the last change to this entity and any sub-entities. | ||
|
||
<a id="nestedblock--selector"></a> | ||
### Nested Schema for `selector` | ||
|
||
Required: | ||
|
||
- `key` (String) The key that is used to match the key property of a Label. | ||
|
||
Optional: | ||
|
||
- `operator` (String) The SelectorOp used as part of the label matching operation. Can be one of: Exists, NotExists, Equals, NotEquals, In, NotIn, MinOf, MaxOf. Defaults to In. | ||
- `values` (List of String) The values to be used during deployment planning. If operator is Exists, NotExists, MinOf or MaxOf this should be empty. | ||
|
||
Read-Only: | ||
|
||
- `id` (String) The unique identifier of the Selector. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "ogc_remote_endpoint Resource - ogc" | ||
subcategory: "" | ||
description: |- | ||
Represents a layer-3/4 network destination not directly managed by OGC, i.e. an accessible network resource outside the Ori configuration/deployment. | ||
--- | ||
|
||
# ogc_remote_endpoint (Resource) | ||
|
||
Represents a layer-3/4 network destination not directly managed by OGC, i.e. an accessible network resource outside the Ori configuration/deployment. | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
resource "ogc_remote_endpoint" "re" { | ||
display_name = "example" | ||
package_id = ogc_package.pkg.id | ||
address = "0.0.0.0/0" | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `address` (String) The address on which the parent RemoteEndpoint is to listen in CIDR format (e.g. 123.45.67.0/24). If the subnet portion is omitted it is assumed to be /32 for IPv4 addresses and /128 for IPv6 addresses, i.e. the address is treated as a single item. | ||
- `display_name` (String) The user-supplied name of the RemoteEndpoint. | ||
- `package_id` (String) The id of the parent Package of the RemoteEndpoint. | ||
|
||
### Optional | ||
|
||
- `port` (Number) Port number on which the endpoint is listening. If null then all ports will be used. | ||
- `protocol` (String) TThe IP Protocol to which the endpoint is listening. If null then all protocols supported by K8s will be used. | ||
|
||
### Read-Only | ||
|
||
- `id` (String) The unique identifier of the RemoteEndpoint. |
Oops, something went wrong.