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(rts): fix docs issues. #1031

Merged
merged 1 commit into from
Oct 24, 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
13 changes: 8 additions & 5 deletions docs/data-sources/rts_software_config_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,22 @@ resource "flexibleengine_rts_software_deployment_v1" "mydeployment" {

The following arguments are supported:

* `id` - (Optional) The id of the software configuration.
* `region` - (Optional, String) The region in which to query the data source. If omitted, the provider-level region
will be used.

* `name` - (Optional) The name of the software configuration.
* `id` - (Optional, String) The id of the software configuration.

## Attributes Reference
* `name` - (Optional, String) The name of the software configuration.

## Attribute Reference

In addition to all arguments above, the following attributes are exported:

* `group` - The namespace that groups this software configuration by when it is delivered to a server.

* `inputs` - A list of software configuration inputs.
* `input_values` - A list of software configuration inputs.

* `outputs` - A list of software configuration outputs.
* `output_values` - A list of software configuration outputs.

* `config` - The software configuration code.

Expand Down
13 changes: 8 additions & 5 deletions docs/data-sources/rts_stack_resource_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,18 @@ data "flexibleengine_rts_stack_resource_v1" "stackresource" {

The following arguments are supported:

* `stack_name` - (Required) The unique stack name.
* `region` - (Optional, String) The region in which to query the data source. If omitted, the provider-level region
will be used.

* `resource_name` - (Optional) The name of a resource in the stack.
* `stack_name` - (Required, String) The unique stack name.

* `physical_resource_id` - (Optional) The physical resource ID.
* `resource_name` - (Optional, String) The name of a resource in the stack.

* `resource_type` - (Optional) The resource type.
* `physical_resource_id` - (Optional, String) The physical resource ID.

## Attributes Reference
* `resource_type` - (Optional, String) The resource type.

## Attribute Reference

In addition to all arguments above, the following attributes are exported:

Expand Down
7 changes: 5 additions & 2 deletions docs/data-sources/rts_stack_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,12 @@ data "flexibleengine_rts_stack_v1" "mystack" {

The following arguments are supported:

* `name` - (Required) The name of the stack.
* `region` - (Optional, String) The region in which to query the data source. If omitted, the provider-level region
will be used.

## Attributes Reference
* `name` - (Required, String) The name of the stack.

## Attribute Reference

In addition to all arguments above, the following attributes are exported:

Expand Down
30 changes: 23 additions & 7 deletions docs/resources/rts_software_config_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,24 +22,40 @@ resource "flexibleengine_rts_software_config_v1" "myconfig" {

The following arguments are supported:

* `name` - (Required) The name of the software configuration.
* `region` - (Optional, String, ForceNew) Specifies the region in which to create the RTS software resource.
If omitted, the provider-level region will be used. Changing this will create a new RTS software resource.

* `group` - (Optional) The namespace that groups this software configuration by when it is delivered to a server.
* `name` - (Required, String, ForceNew) The name of the software configuration. Changing this will create a new RTS
software resource.

* `input_values` - (Optional) A list of software configuration inputs.
* `group` - (Optional, String, ForceNew) The namespace that groups this software configuration by when it is delivered
to a server. Changing this will create a new RTS software resource.

* `output_values` - (Optional) A list of software configuration outputs.
* `input_values` - (Optional, List, ForceNew) A list of software configuration inputs. Changing this will create a new
RTS software resource.

* `config` - (Optional) The software configuration code.
* `output_values` - (Optional, List, ForceNew) A list of software configuration outputs. Changing this will create a
new RTS software resource.

* `options` - (Optional) The software configuration options.
* `config` - (Optional, String, ForceNew) The software configuration code. Changing this will create a new RTS software
resource.

## Attributes Reference
* `options` - (Optional, Map, ForceNew) The software configuration options. Changing this will create a new RTS software
resource.

## Attribute Reference

In addition to all arguments above, the following attributes are exported:

* `id` - The id of the software config.

## Timeouts

This resource provides the following timeouts configuration options:

* `create` - Default is 10 minutes.
* `delete` - Default is 3 minutes.

## Import

Software Config can be imported using the `config id`, e.g.
Expand Down
26 changes: 16 additions & 10 deletions docs/resources/rts_stack_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,25 +78,31 @@ STACK

The following arguments are supported:

* `name` - (Required) A unique name for the stack. The value must meet the regular expression rule (`^[a-zA-Z][a-zA-Z0-9_.-]{0,254}$`).
* `region` - (Optional, String, ForceNew) Specifies the region in which to create the RTS stack resource.
If omitted, the provider-level region will be used. Changing this will create a new RTS stack resource.

* `name` - (Required, String, ForceNew) Specifies the name of the resource stack.
The valid length is limited from can contain 1 to 64, only letters, digits and hyphens (-) are allowed.
The name must start with a lowercase letter and end with a lowercase letter or digit.
Changing this creates a new stack.

* `template_body` - (Optional; Required if `template_url` is empty) Structure containing the template body.
The template content must use the yaml syntax.
* `template_body` - (Optional, String) Structure containing the template body. The template content must use the yaml
syntax. It is **Required** if `template_url` is empty.

* `template_url` - (Optional; Required if `template_body` is empty) Location of a file containing the template body.
* `template_url` - (Optional, String) Location of a file containing the template body. It is **Required** if
`template_body` is empty

* `environment` - (Optional) Tthe environment information about the stack.
* `environment` - (Optional, String) The environment information about the stack.

* `files` - (Optional) Files used in the environment.
* `files` - (Optional, Map) Files used in the environment.

* `parameters` - (Optional) A list of Parameter structures that specify input parameters for the stack.
* `parameters` - (Optional, Map) A list of Parameter structures that specify input parameters for the stack.

* `disable_rollback` - (Optional) Set to true to disable rollback of the stack if stack creation failed.
* `disable_rollback` - (Optional, Bool) Set to true to disable rollback of the stack if stack creation failed.

* `timeout_mins` - (Optional) Specifies the timeout duration.
* `timeout_mins` - (Optional, Int) Specifies the timeout duration.

## Attributes Reference
## Attribute Reference

In addition to all arguments above, the following attributes are exported:

Expand Down
Loading