Updated documentation

OctopusDeployLabs · Feb 2, 2021 · 76acdc6 · 76acdc6
1 parent 5c4214c
commit 76acdc6
Show file tree

Hide file tree

Showing 2 changed files with 91 additions and 90 deletions.
diff --git a/docs/resources/deployment_process.md b/docs/resources/deployment_process.md
@@ -81,7 +81,7 @@ Optional:
 - **notes** (String) The notes associated with this deploymnt action.
 - **package** (Block Set) The primary package for the action (see [below for nested schema](#nestedblock--step--action--package))
 - **primary_package** (Block Set, Max: 1) The primary package for the action (see [below for nested schema](#nestedblock--step--action--primary_package))
-- **properties** (Map of String)
+- **properties** (Map of String) The properties associated with this deployment action.
 - **run_on_server** (Boolean) Whether this step runs on a worker or on the target
 - **tenant_tags** (List of String) A list of tenant tags associated with this resource.
 - **worker_pool_id** (String) The worker pool associated with this deployment action.
@@ -135,7 +135,6 @@ Optional:
 Required:
 
 - **name** (String) The name of this resource.
-- **package** (Block Set, Min: 1) The primary package for the action (see [below for nested schema](#nestedblock--step--apply_terraform_action--package))
 
 Optional:
 
@@ -150,11 +149,21 @@ Optional:
 - **is_disabled** (Boolean) Indicates the disabled status of this deployment action.
 - **is_required** (Boolean) Indicates the required status of this deployment action.
 - **notes** (String) The notes associated with this deploymnt action.
+- **package** (Block Set) The primary package for the action (see [below for nested schema](#nestedblock--step--apply_terraform_action--package))
 - **primary_package** (Block Set, Max: 1) The primary package for the action (see [below for nested schema](#nestedblock--step--apply_terraform_action--primary_package))
-- **properties** (Map of String)
+- **properties** (Map of String) The properties associated with this deployment action.
 - **run_on_server** (Boolean) Whether this step runs on a worker or on the target
 - **tenant_tags** (List of String) A list of tenant tags associated with this resource.
 
+<a id="nestedblock--step--apply_terraform_action--container"></a>
+### Nested Schema for `step.apply_terraform_action.container`
+
+Optional:
+
+- **feed_id** (String)
+- **image** (String)
+
+
 <a id="nestedblock--step--apply_terraform_action--package"></a>
 ### Nested Schema for `step.apply_terraform_action.package`
 
@@ -171,15 +180,6 @@ Optional:
 - **properties** (Map of String)
 
 
-<a id="nestedblock--step--apply_terraform_action--container"></a>
-### Nested Schema for `step.apply_terraform_action.container`
-
-Optional:
-
-- **feed_id** (String)
-- **image** (String)
-
-
 <a id="nestedblock--step--apply_terraform_action--primary_package"></a>
 ### Nested Schema for `step.apply_terraform_action.primary_package`
 
@@ -203,7 +203,6 @@ Optional:
 Required:
 
 - **name** (String) The name of this resource.
-- **package** (Block Set, Min: 1) The primary package for the action (see [below for nested schema](#nestedblock--step--deploy_kubernetes_secret_action--package))
 - **secret_name** (String) The name of the secret resource
 - **secret_values** (Block List, Min: 1) (see [below for nested schema](#nestedblock--step--deploy_kubernetes_secret_action--secret_values))
 
@@ -219,26 +218,11 @@ Optional:
 - **is_disabled** (Boolean) Indicates the disabled status of this deployment action.
 - **is_required** (Boolean) Indicates the required status of this deployment action.
 - **notes** (String) The notes associated with this deploymnt action.
-- **properties** (Map of String)
+- **package** (Block Set) The primary package for the action (see [below for nested schema](#nestedblock--step--deploy_kubernetes_secret_action--package))
+- **properties** (Map of String) The properties associated with this deployment action.
 - **run_on_server** (Boolean) Whether this step runs on a worker or on the target
 - **tenant_tags** (List of String) A list of tenant tags associated with this resource.
 
-<a id="nestedblock--step--deploy_kubernetes_secret_action--package"></a>
-### Nested Schema for `step.deploy_kubernetes_secret_action.package`
-
-Required:
-
-- **package_id** (String) The ID of the package
-
-Optional:
-
-- **acquisition_location** (String) Whether to acquire this package on the server ('Server'), target ('ExecutionTarget') or not at all ('NotAcquired'). Can be an expression
-- **feed_id** (String) The feed ID associated with this package reference.
-- **id** (String) The unique ID for this resource.
-- **name** (String) The name of this resource.
-- **properties** (Map of String)
-
-
 <a id="nestedblock--step--deploy_kubernetes_secret_action--secret_values"></a>
 ### Nested Schema for `step.deploy_kubernetes_secret_action.secret_values`
 
@@ -257,14 +241,29 @@ Optional:
 - **image** (String)
 
 
+<a id="nestedblock--step--deploy_kubernetes_secret_action--package"></a>
+### Nested Schema for `step.deploy_kubernetes_secret_action.package`
+
+Required:
+
+- **package_id** (String) The ID of the package
+
+Optional:
+
+- **acquisition_location** (String) Whether to acquire this package on the server ('Server'), target ('ExecutionTarget') or not at all ('NotAcquired'). Can be an expression
+- **feed_id** (String) The feed ID associated with this package reference.
+- **id** (String) The unique ID for this resource.
+- **name** (String) The name of this resource.
+- **properties** (Map of String)
+
+
 
 <a id="nestedblock--step--deploy_package_action"></a>
 ### Nested Schema for `step.deploy_package_action`
 
 Required:
 
 - **name** (String) The name of this resource.
-- **package** (Block Set, Min: 1) The primary package for the action (see [below for nested schema](#nestedblock--step--deploy_package_action--package))
 - **primary_package** (Block Set, Min: 1, Max: 1) The primary package for the action (see [below for nested schema](#nestedblock--step--deploy_package_action--primary_package))
 
 Optional:
@@ -279,12 +278,13 @@ Optional:
 - **is_disabled** (Boolean) Indicates the disabled status of this deployment action.
 - **is_required** (Boolean) Indicates the required status of this deployment action.
 - **notes** (String) The notes associated with this deploymnt action.
-- **properties** (Map of String)
+- **package** (Block Set) The primary package for the action (see [below for nested schema](#nestedblock--step--deploy_package_action--package))
+- **properties** (Map of String) The properties associated with this deployment action.
 - **tenant_tags** (List of String) A list of tenant tags associated with this resource.
 - **windows_service** (Block Set, Max: 1) Deploy a windows service feature (see [below for nested schema](#nestedblock--step--deploy_package_action--windows_service))
 
-<a id="nestedblock--step--deploy_package_action--package"></a>
-### Nested Schema for `step.deploy_package_action.package`
+<a id="nestedblock--step--deploy_package_action--primary_package"></a>
+### Nested Schema for `step.deploy_package_action.primary_package`
 
 Required:
 
@@ -299,8 +299,17 @@ Optional:
 - **properties** (Map of String)
 
 
-<a id="nestedblock--step--deploy_package_action--primary_package"></a>
-### Nested Schema for `step.deploy_package_action.primary_package`
+<a id="nestedblock--step--deploy_package_action--container"></a>
+### Nested Schema for `step.deploy_package_action.container`
+
+Optional:
+
+- **feed_id** (String)
+- **image** (String)
+
+
+<a id="nestedblock--step--deploy_package_action--package"></a>
+### Nested Schema for `step.deploy_package_action.package`
 
 Required:
 
@@ -315,15 +324,6 @@ Optional:
 - **properties** (Map of String)
 
 
-<a id="nestedblock--step--deploy_package_action--container"></a>
-### Nested Schema for `step.deploy_package_action.container`
-
-Optional:
-
-- **feed_id** (String)
-- **image** (String)
-
-
 <a id="nestedblock--step--deploy_package_action--windows_service"></a>
 ### Nested Schema for `step.deploy_package_action.windows_service`
 
@@ -352,7 +352,6 @@ Required:
 
 - **executable_path** (String) The path to the executable relative to the package installation directory
 - **name** (String) The name of this resource.
-- **package** (Block Set, Min: 1) The primary package for the action (see [below for nested schema](#nestedblock--step--deploy_windows_service_action--package))
 - **primary_package** (Block Set, Min: 1, Max: 1) The primary package for the action (see [below for nested schema](#nestedblock--step--deploy_windows_service_action--primary_package))
 - **service_name** (String) The name of the service
 
@@ -374,13 +373,14 @@ Optional:
 - **is_disabled** (Boolean) Indicates the disabled status of this deployment action.
 - **is_required** (Boolean) Indicates the required status of this deployment action.
 - **notes** (String) The notes associated with this deploymnt action.
-- **properties** (Map of String)
+- **package** (Block Set) The primary package for the action (see [below for nested schema](#nestedblock--step--deploy_windows_service_action--package))
+- **properties** (Map of String) The properties associated with this deployment action.
 - **service_account** (String) Which built-in account will the service run under. Can be LocalSystem, NT Authority\NetworkService, NT Authority\LocalService, _CUSTOM or an expression
 - **start_mode** (String) When will the service start. Can be auto, delayed-auto, manual, unchanged or an expression
 - **tenant_tags** (List of String) A list of tenant tags associated with this resource.
 
-<a id="nestedblock--step--deploy_windows_service_action--package"></a>
-### Nested Schema for `step.deploy_windows_service_action.package`
+<a id="nestedblock--step--deploy_windows_service_action--primary_package"></a>
+### Nested Schema for `step.deploy_windows_service_action.primary_package`
 
 Required:
 
@@ -395,8 +395,17 @@ Optional:
 - **properties** (Map of String)
 
 
-<a id="nestedblock--step--deploy_windows_service_action--primary_package"></a>
-### Nested Schema for `step.deploy_windows_service_action.primary_package`
+<a id="nestedblock--step--deploy_windows_service_action--container"></a>
+### Nested Schema for `step.deploy_windows_service_action.container`
+
+Optional:
+
+- **feed_id** (String)
+- **image** (String)
+
+
+<a id="nestedblock--step--deploy_windows_service_action--package"></a>
+### Nested Schema for `step.deploy_windows_service_action.package`
 
 Required:
 
@@ -411,15 +420,6 @@ Optional:
 - **properties** (Map of String)
 
 
-<a id="nestedblock--step--deploy_windows_service_action--container"></a>
-### Nested Schema for `step.deploy_windows_service_action.container`
-
-Optional:
-
-- **feed_id** (String)
-- **image** (String)
-
-
 
 <a id="nestedblock--step--manual_intervention_action"></a>
 ### Nested Schema for `step.manual_intervention_action`
@@ -428,7 +428,6 @@ Required:
 
 - **instructions** (String) The instructions for the user to follow
 - **name** (String) The name of this resource.
-- **package** (Block Set, Min: 1) The primary package for the action (see [below for nested schema](#nestedblock--step--manual_intervention_action--package))
 
 Optional:
 
@@ -442,10 +441,20 @@ Optional:
 - **is_disabled** (Boolean) Indicates the disabled status of this deployment action.
 - **is_required** (Boolean) Indicates the required status of this deployment action.
 - **notes** (String) The notes associated with this deploymnt action.
-- **properties** (Map of String)
+- **package** (Block Set) The primary package for the action (see [below for nested schema](#nestedblock--step--manual_intervention_action--package))
+- **properties** (Map of String) The properties associated with this deployment action.
 - **responsible_teams** (String) The teams responsible to resolve this step. If no teams are specified, all users who have permission to deploy the project can resolve it.
 - **tenant_tags** (List of String) A list of tenant tags associated with this resource.
 
+<a id="nestedblock--step--manual_intervention_action--container"></a>
+### Nested Schema for `step.manual_intervention_action.container`
+
+Optional:
+
+- **feed_id** (String)
+- **image** (String)
+
+
 <a id="nestedblock--step--manual_intervention_action--package"></a>
 ### Nested Schema for `step.manual_intervention_action.package`
 
@@ -462,15 +471,6 @@ Optional:
 - **properties** (Map of String)
 
 
-<a id="nestedblock--step--manual_intervention_action--container"></a>
-### Nested Schema for `step.manual_intervention_action.container`
-
-Optional:
-
-- **feed_id** (String)
-- **image** (String)
-
-
 
 <a id="nestedblock--step--run_kubectl_script_action"></a>
 ### Nested Schema for `step.run_kubectl_script_action`
@@ -493,7 +493,7 @@ Optional:
 - **notes** (String) The notes associated with this deploymnt action.
 - **package** (Block Set) The primary package for the action (see [below for nested schema](#nestedblock--step--run_kubectl_script_action--package))
 - **primary_package** (Block Set, Max: 1) The primary package for the action (see [below for nested schema](#nestedblock--step--run_kubectl_script_action--primary_package))
-- **properties** (Map of String)
+- **properties** (Map of String) The properties associated with this deployment action.
 - **run_on_server** (Boolean) Whether this step runs on a worker or on the target
 - **script_file_name** (String) The script file name in the package
 - **script_parameters** (String) Parameters expected by the script. Use platform specific calling convention. e.g. -Path #{VariableStoringPath} for PowerShell or -- #{VariableStoringPath} for ScriptCS
@@ -563,7 +563,7 @@ Optional:
 - **notes** (String) The notes associated with this deploymnt action.
 - **package** (Block Set) The primary package for the action (see [below for nested schema](#nestedblock--step--run_script_action--package))
 - **primary_package** (Block Set, Max: 1) The primary package for the action (see [below for nested schema](#nestedblock--step--run_script_action--primary_package))
-- **properties** (Map of String)
+- **properties** (Map of String) The properties associated with this deployment action.
 - **run_on_server** (Boolean) Whether this step runs on a worker or on the target
 - **script_file_name** (String) The script file name in the package
 - **script_parameters** (String) Parameters expected by the script. Use platform specific calling convention. e.g. -Path #{VariableStoringPath} for PowerShell or -- #{VariableStoringPath} for ScriptCS

diff --git a/docs/resources/project.md b/docs/resources/project.md
@@ -49,7 +49,7 @@ resource "octopusdeploy_project" "example" {
 - **auto_create_release** (Boolean)
 - **auto_deploy_release_overrides** (List of String)
 - **cloned_from_project_id** (String)
-- **connectivity_policy** (Block List) (see [below for nested schema](#nestedblock--connectivity_policy))
+- **connectivity_policy** (Block List, Max: 1) (see [below for nested schema](#nestedblock--connectivity_policy))
 - **default_guided_failure_mode** (String)
 - **default_to_skip_if_already_installed** (Boolean)
 - **deployment_changes_template** (String)
@@ -67,14 +67,14 @@ resource "octopusdeploy_project" "example" {
 - **templates** (Block List) (see [below for nested schema](#nestedblock--templates))
 - **tenanted_deployment_participation** (String) The tenanted deployment mode of the resource. Valid account types are `Untenanted`, `TenantedOrUntenanted`, or `Tenanted`.
 - **version_control_settings** (Block Set, Max: 1) (see [below for nested schema](#nestedblock--version_control_settings))
+- **versioning_strategy** (Block Set) (see [below for nested schema](#nestedblock--versioning_strategy))
 
 ### Read-only
 
 - **deployment_process_id** (String)
 - **extension_settings** (Block Set) (see [below for nested schema](#nestedblock--extension_settings))
 - **slug** (String)
 - **variable_set_id** (String)
-- **versioning_strategy** (Block Set) (see [below for nested schema](#nestedblock--versioning_strategy))
 
 <a id="nestedblock--connectivity_policy"></a>
 ### Nested Schema for `connectivity_policy`
@@ -129,36 +129,37 @@ Optional:
 
 - **default_branch** (String) The default branch associated with these version control settings.
 - **password** (String, Sensitive) The password associated with these version control settings.
-- **url** (String)
-- **username** (String, Sensitive) The username associated with this resource.
-
-
-<a id="nestedblock--extension_settings"></a>
-### Nested Schema for `extension_settings`
-
-Read-only:
-
-- **extension_id** (String)
-- **values** (List of String)
+- **url** (String) The URL associated with these version control settings.
+- **username** (String, Sensitive) The username associated with these version control settings.
 
 
 <a id="nestedblock--versioning_strategy"></a>
 ### Nested Schema for `versioning_strategy`
 
-Read-only:
+Optional:
 
-- **donor_package** (List of Object) (see [below for nested schema](#nestedatt--versioning_strategy--donor_package))
+- **donor_package** (Block List, Max: 1) (see [below for nested schema](#nestedblock--versioning_strategy--donor_package))
 - **donor_package_step_id** (String)
 - **template** (String)
 
-<a id="nestedatt--versioning_strategy--donor_package"></a>
+<a id="nestedblock--versioning_strategy--donor_package"></a>
 ### Nested Schema for `versioning_strategy.donor_package`
 
-Read-only:
+Optional:
 
 - **deployment_action** (String)
 - **package_reference** (String)
 
+
+
+<a id="nestedblock--extension_settings"></a>
+### Nested Schema for `extension_settings`
+
+Read-only:
+
+- **extension_id** (String)
+- **values** (List of String)
+
 ## Import
 
 Import is supported using the following syntax: