Skip to content

Commit

Permalink
chore(docs): update runbook resource docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hnrkndrssn committed Aug 8, 2024
1 parent 31287ca commit 36f905d
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
10 changes: 5 additions & 5 deletions docs/resources/runbook.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,16 @@ This resource manages runbooks in Octopus Deploy.

### Optional

- `connectivity_policy` (Block List, Max: 1) (see [below for nested schema](#nestedblock--connectivity_policy))
- `connectivity_policy` (Block List) (see [below for nested schema](#nestedblock--connectivity_policy))
- `default_guided_failure_mode` (String) Sets the runbook guided failure mode.
- `description` (String) The description of this runbook.
- `environment_scope` (String) Determines how the runbook is scoped to environments.
- `environments` (List of String) When environment_scope is set to "Specified", this is the list of environments the runbook can be run against.
- `force_package_download` (Boolean) Whether to force packages to be re-downloaded or not
- `force_package_download` (Boolean) Whether to force packages to be re-downloaded or not.
- `id` (String) The unique ID for this resource.
- `multi_tenancy_mode` (String) The tenanted deployment mode of the resource. Valid account types are `Untenanted`, `TenantedOrUntenanted`, or `Tenanted`.
- `retention_policy` (Block List, Max: 1) Sets the runbook retention policy (see [below for nested schema](#nestedblock--retention_policy))
- `space_id` (String) The space ID associated with this resource.
- `multi_tenancy_mode` (String) The tenanted deployment mode of the runbook. Valid modes are `Untenanted`, `TenantedOrUntenanted`, `Tenanted`
- `retention_policy` (Block List) Sets the runbook retention policy. (see [below for nested schema](#nestedblock--retention_policy))
- `space_id` (String) The space ID associated with this runbook.

### Read-Only

Expand Down
4 changes: 1 addition & 3 deletions octopusdeploy_framework/schemas/runbook.go
Original file line number Diff line number Diff line change
Expand Up @@ -155,15 +155,13 @@ func GetRunbookResourceSchema() resourceSchema.Schema {
RunbookSchemaAttributeNames.RunbookProcessID: resourceSchema.StringAttribute{
Description: "The runbook process ID.",
Computed: true,
Optional: true,
PlanModifiers: []planmodifier.String{
stringplanmodifier.UseStateForUnknown(),
},
},
RunbookSchemaAttributeNames.PublishedRunbookSnapshotID: resourceSchema.StringAttribute{
Description: "The published snapshot ID.",
Computed: true,
Optional: true,
PlanModifiers: []planmodifier.String{
stringplanmodifier.UseStateForUnknown(),
},
Expand Down Expand Up @@ -192,7 +190,7 @@ func GetRunbookResourceSchema() resourceSchema.Schema {
},
},
RunbookSchemaAttributeNames.Environments: resourceSchema.ListAttribute{
Description: fmt.Sprintf("When %s is set to \"%s\", this is the list of environments the runbook can be run agains.", RunbookSchemaAttributeNames.EnvironmentScope, environmentScopeNames.Specified),
Description: fmt.Sprintf("When %s is set to \"%s\", this is the list of environments the runbook can be run against.", RunbookSchemaAttributeNames.EnvironmentScope, environmentScopeNames.Specified),
Optional: true,
Computed: true,
ElementType: types.StringType,
Expand Down

0 comments on commit 36f905d

Please sign in to comment.