Skip to content

Commit

Permalink
generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
maciaszczykm committed Apr 22, 2024
1 parent 1b006ac commit 9cec940
Show file tree
Hide file tree
Showing 3 changed files with 138 additions and 5 deletions.
4 changes: 2 additions & 2 deletions docs/resources/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ Required:
Optional:

- `args` (List of String) Arguments to pass to the command when executing it.
- `env` (Map of String) Defines environment variables to expose to the process.
- `env` (Map of String) Defines environment variables to expose to the process.



Expand Down Expand Up @@ -186,7 +186,7 @@ Required:
Optional:

- `args` (List of String) Arguments to pass to the command when executing it.
- `env` (Map of String) Defines environment variables to expose to the process.
- `env` (Map of String) Defines environment variables to expose to the process.



Expand Down
136 changes: 136 additions & 0 deletions docs/resources/infrastructure_stack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "plural_infrastructure_stack Resource - terraform-provider-plural"
subcategory: ""
description: |-
---

# plural_infrastructure_stack (Resource)





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

### Required

- `cluster_id` (String) The cluster on which the stack will be applied.
- `configuration` (Attributes) Stack configuration. (see [below for nested schema](#nestedatt--configuration))
- `name` (String) Human-readable name of this stack.
- `repository` (Attributes) Repository information used to pull stack. (see [below for nested schema](#nestedatt--repository))
- `type` (String) A type for the stack, specifies the tool to use to apply it. Allowed values include `ANSIBLE` and `TERRAFORM`.

### Optional

- `approval` (Boolean) Determines whether to require approval.
- `bindings` (Attributes) Read and write policies of this stack. (see [below for nested schema](#nestedatt--bindings))
- `environment` (Attributes Set) Defines environment variables for the stack. (see [below for nested schema](#nestedatt--environment))
- `files` (Map of String) File path-content map.
- `job_spec` (Attributes) Repository information used to pull stack. (see [below for nested schema](#nestedatt--job_spec))

### Read-Only

- `id` (String) Internal identifier of this stack.

<a id="nestedatt--configuration"></a>
### Nested Schema for `configuration`

Required:

- `version` (String) The semver of the tool you wish to use.

Optional:

- `image` (String) Optional custom image you might want to use.


<a id="nestedatt--repository"></a>
### Nested Schema for `repository`

Required:

- `folder` (String) The folder where manifests live.
- `id` (String) ID of the repository to pull from.
- `ref` (String) A general git ref, either a branch name or commit sha understandable by "git checkout <ref>".


<a id="nestedatt--bindings"></a>
### Nested Schema for `bindings`

Optional:

- `read` (Attributes Set) Read policies of this stack. (see [below for nested schema](#nestedatt--bindings--read))
- `write` (Attributes Set) Write policies of this stack. (see [below for nested schema](#nestedatt--bindings--write))

<a id="nestedatt--bindings--read"></a>
### Nested Schema for `bindings.read`

Optional:

- `group_id` (String)
- `id` (String)
- `user_id` (String)


<a id="nestedatt--bindings--write"></a>
### Nested Schema for `bindings.write`

Optional:

- `group_id` (String)
- `id` (String)
- `user_id` (String)



<a id="nestedatt--environment"></a>
### Nested Schema for `environment`

Required:

- `name` (String) Environment variable name.
- `value` (String) Environment variable value.

Optional:

- `secret` (Boolean) Indicates if environment variable is secret.


<a id="nestedatt--job_spec"></a>
### Nested Schema for `job_spec`

Required:

- `namespace` (String) Namespace where job will be deployed.

Optional:

- `annotations` (Map of String) Kubernetes annotations applied to the job.
- `containers` (Attributes Set) (see [below for nested schema](#nestedatt--job_spec--containers))
- `labels` (Map of String) Kubernetes labels applied to the job.
- `raw` (String) If you'd rather define the job spec via straight Kubernetes YAML.
- `service_account` (String) Kubernetes service account for this job.

<a id="nestedatt--job_spec--containers"></a>
### Nested Schema for `job_spec.containers`

Required:

- `image` (String)

Optional:

- `args` (Set of String) Arguments to pass to the command when executing it.
- `env` (Map of String) Defines environment variables to expose to the process.
- `env_from` (Attributes Set) (see [below for nested schema](#nestedatt--job_spec--containers--env_from))

<a id="nestedatt--job_spec--containers--env_from"></a>
### Nested Schema for `job_spec.containers.env_from`

Required:

- `config_map` (String)
- `secret` (String)
3 changes: 0 additions & 3 deletions internal/resource/infrastructure_stack_schema.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ import (
"github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
"github.com/hashicorp/terraform-plugin-framework/path"
"github.com/hashicorp/terraform-plugin-framework/resource/schema"
"github.com/hashicorp/terraform-plugin-framework/resource/schema/booldefault"
"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier"
"github.com/hashicorp/terraform-plugin-framework/schema/validator"
Expand Down Expand Up @@ -42,7 +41,6 @@ func (r *InfrastructureStackResource) schema() schema.Schema {
Description: "Determines whether to require approval.",
MarkdownDescription: "Determines whether to require approval.",
Optional: true,
Default: booldefault.StaticBool(false),
},
"cluster_id": schema.StringAttribute{
Description: "The cluster on which the stack will be applied.",
Expand Down Expand Up @@ -114,7 +112,6 @@ func (r *InfrastructureStackResource) schema() schema.Schema {
Description: "Indicates if environment variable is secret.",
MarkdownDescription: "Indicates if environment variable is secret.",
Optional: true,
Default: booldefault.StaticBool(false),
},
},
},
Expand Down

0 comments on commit 9cec940

Please sign in to comment.