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.

Sign up for GitHub

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

Jump to bottom

schematics agent doc fixes #4933

Merged
merged 1 commit into from
Nov 21, 2023
Merged

schematics agent doc fixes #4933

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
31 changes: 0 additions & 31 deletions website/docs/d/schematics_agent.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,37 +42,6 @@ Nested scheme for **agent_infrastructure**:
* `cos_instance_name` - (String) The COS instance name to store the agent logs.
* `infra_type` - (String) Type of target agent infrastructure.
* Constraints: Allowable values are: `ibm_kubernetes`, `ibm_openshift`, `ibm_satellite`.

* `agent_inputs` - (List) Additional input variables for the agent.
Nested scheme for **agent_inputs**:
* `link` - (String) The reference link to the variable value By default the expression points to `$self.value`.
* `metadata` - (List) An user editable metadata for the variables.
Nested scheme for **metadata**:
* `aliases` - (List) The list of aliases for the variable name.
* `cloud_data_type` - (String) Cloud data type of the variable. eg. resource_group_id, region, vpc_id.
* `default_value` - (String) Default value for the variable only if the override value is not specified.
* `description` - (String) The description of the meta data.
* `group_by` - (String) The display name of the group this variable belongs to.
* `hidden` - (Boolean) If **true**, the variable is not displayed on UI or Command line.
* `immutable` - (Boolean) Is the variable readonly ?.
* `link_status` - (String) The status of the link.
* Constraints: Allowable values are: `normal`, `broken`.
* `matches` - (String) The regex for the variable value.
* `max_length` - (Integer) The maximum length of the variable value. Applicable for the string type.
* `max_value` - (Integer) The maximum value of the variable. Applicable for the integer type.
* `min_length` - (Integer) The minimum length of the variable value. Applicable for the string type.
* `min_value` - (Integer) The minimum value of the variable. Applicable for the integer type.
* `options` - (List) The list of possible values for this variable. If type is **integer** or **date**, then the array of string is converted to array of integers or date during the runtime.
* `position` - (Integer) The relative position of this variable in a list.
* `required` - (Boolean) If the variable required?.
* `secure` - (Boolean) Is the variable secure or sensitive ?.
* `source` - (String) The source of this meta-data.
* `type` - (String) Type of the variable.
* Constraints: Allowable values are: `boolean`, `string`, `integer`, `date`, `array`, `list`, `map`, `complex`, `link`.
* `name` - (String) The name of the variable. For example, `name = "inventory username"`.
* `use_default` - (Boolean) True, will ignore the data in the value attribute, instead the data in metadata.default_value will be used.
* `value` - (String) The value for the variable or reference to the value. For example, `value = "<provide your ssh_key_value with \n>"`. **Note** The SSH key should contain `\n` at the end of the key details in case of command line or API calls.

* `agent_kpi` - (List) Schematics Agent key performance indicators.
Nested scheme for **agent_kpi**:
* `application_indicators` - (List) Agent application key performance indicators.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/schematics_agents.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Nested scheme for **agents**:
* `id` - (String) The Agent registration id.
* `location` - (String) List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.
* Constraints: Allowable values are: `us-south`, `us-east`, `eu-gb`, `eu-de`.
* `name` - (String) The name of the agent (must be unique, for an account).
* `name` - (String) The name of the agent.
* `profile_id` - (String) The IAM trusted profile id, used by the Agent instance.
* `registered_at` - (String) The Agent registration date-time.
* `registered_by` - (String) The email address of an user who registered the Agent.
Expand Down
72 changes: 2 additions & 70 deletions website/docs/r/schematics_agent.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,40 +24,6 @@ resource "ibm_schematics_agent" "schematics_agent_instance" {
cos_bucket_name = "cos_bucket_name"
cos_bucket_region = "cos_bucket_region"
}
agent_inputs {
name = "name"
value = "value"
use_default = true
metadata {
type = "boolean"
aliases = [ "aliases" ]
description = "description"
cloud_data_type = "cloud_data_type"
default_value = "default_value"
link_status = "normal"
secure = true
immutable = true
hidden = true
required = true
options = [ "options" ]
min_value = 1
max_value = 1
min_length = 1
max_length = 1
matches = "matches"
position = 1
group_by = "group_by"
source = "source"
}
link = "link"
}
agent_kpi {
availability_indicator = "available"
lifecycle_indicator = "consistent"
percent_usage_indicator = "percent_usage_indicator"
application_indicators = [ null ]
infra_indicators = [ null ]
}
agent_location = "us-south"
agent_metadata {
name = "purpose"
Expand All @@ -67,12 +33,7 @@ resource "ibm_schematics_agent" "schematics_agent_instance" {
name = "MyDevAgent"
resource_group = "Default"
schematics_location = "us-south"
user_state {
state = "enable"
set_by = "set_by"
set_at = "2021-01-31T09:44:12Z"
}
version = "v1.0.0"
version = "1.0.0-beta2"
}
```

Expand All @@ -89,35 +50,6 @@ Nested scheme for **agent_infrastructure**:
* `cos_instance_name` - (Optional, String) The COS instance name to store the agent logs.
* `infra_type` - (Optional, String) Type of target agent infrastructure.
* Constraints: Allowable values are: `ibm_kubernetes`, `ibm_openshift`, `ibm_satellite`.
* `agent_inputs` - (Optional, List) Additional input variables for the agent.
Nested scheme for **agent_inputs**:
* `link` - (Computed, String) The reference link to the variable value By default the expression points to `$self.value`.
* `metadata` - (Optional, List) An user editable metadata for the variables.
Nested scheme for **metadata**:
* `aliases` - (Optional, List) The list of aliases for the variable name.
* `cloud_data_type` - (Optional, String) Cloud data type of the variable. eg. resource_group_id, region, vpc_id.
* `default_value` - (Optional, String) Default value for the variable only if the override value is not specified.
* `description` - (Optional, String) The description of the meta data.
* `group_by` - (Optional, String) The display name of the group this variable belongs to.
* `hidden` - (Optional, Boolean) If **true**, the variable is not displayed on UI or Command line.
* `immutable` - (Optional, Boolean) Is the variable readonly ?.
* `link_status` - (Optional, String) The status of the link.
* Constraints: Allowable values are: `normal`, `broken`.
* `matches` - (Optional, String) The regex for the variable value.
* `max_length` - (Optional, Integer) The maximum length of the variable value. Applicable for the string type.
* `max_value` - (Optional, Integer) The maximum value of the variable. Applicable for the integer type.
* `min_length` - (Optional, Integer) The minimum length of the variable value. Applicable for the string type.
* `min_value` - (Optional, Integer) The minimum value of the variable. Applicable for the integer type.
* `options` - (Optional, List) The list of possible values for this variable. If type is **integer** or **date**, then the array of string is converted to array of integers or date during the runtime.
* `position` - (Optional, Integer) The relative position of this variable in a list.
* `required` - (Optional, Boolean) If the variable required?.
* `secure` - (Optional, Boolean) Is the variable secure or sensitive ?.
* `source` - (Optional, String) The source of this meta-data.
* `type` - (Optional, String) Type of the variable.
* Constraints: Allowable values are: `boolean`, `string`, `integer`, `date`, `array`, `list`, `map`, `complex`, `link`.
* `name` - (Optional, String) The name of the variable. For example, `name = "inventory username"`.
* `use_default` - (Optional, Boolean) True, will ignore the data in the value attribute, instead the data in metadata.default_value will be used.
* `value` - (Optional, String) The value for the variable or reference to the value. For example, `value = "<provide your ssh_key_value with \n>"`. **Note** The SSH key should contain `\n` at the end of the key details in case of command line or API calls.
* `agent_kpi` - (Optional, List) Schematics Agent key performance indicators.
Nested scheme for **agent_kpi**:
* `application_indicators` - (Optional, List) Agent application key performance indicators.
Expand All @@ -144,7 +76,7 @@ Nested scheme for **user_state**:
* `set_by` - (Computed, String) Name of the User who set the state of the Object.
* `state` - (Optional, String) User-defined states * `enable` Agent is enabled by the user. * `disable` Agent is disbaled by the user.
* Constraints: Allowable values are: `enable`, `disable`.
* `version` - (Required, String) Agent version.
* `version` - (Required, String) Agent version. Available Versions are 1.0.0-beta1, 1.0.0-beta2

## Attribute Reference

Expand Down