Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Arguments ¶
type Arguments struct {
InsecureTls bool `json:"insecureTls" jsonschema:"Ignore certificate errors when connecting to the Octopus server."`
ExperimentalEnableStepTemplates bool `` /* 201-byte string literal not displayed */
Profiling bool `json:"profiling" jsonschema:"Enable profiling. Run 'pprof -http=:8080 octoterra.prof' to view the results."`
ExcludeTerraformVariables bool `` /* 329-byte string literal not displayed */
ExcludeSpaceCreation bool `json:"excludeSpaceCreation" jsonschema:"This option excludes the Terraform configuration that is used to create the space."`
ConfigFile string `json:"configFile" jsonschema:"The name of the configuration file to use. Do not include the extension. Defaults to octoterra"`
ConfigPath string `json:"configPath" jsonschema:"The path of the configuration file to use. Defaults to the current directory"`
Version bool `json:"version" jsonschema:"Print the version"`
IgnoreInvalidExcludeExcept bool `` /* 470-byte string literal not displayed */
Url string `` /* 191-byte string literal not displayed */
ApiKey string `` /* 163-byte string literal not displayed */
AccessToken string `json:"accessToken" jsonschema:"The Octopus access token"`
UseRedirector bool `json:"useRedirector" jsonschema:"Set to true to access the Octopus instance via the redirector"`
RedirectorHost string `json:"redirectorHost" jsonschema:"The hostname of the redirector service"`
RedirectorServiceApiKey string `json:"redirectorServiceApiKey" jsonschema:"The service api key of the redirector service"`
RedirecrtorApiKey string `json:"redirecrtorApiKey" jsonschema:"The user api key of the redirector service"`
RedirectorRedirections string `json:"redirectorRedirections" jsonschema:"The redirection rules for the redirector service"`
Space string `json:"space" jsonschema:"The Octopus space name or ID"`
Destination string `json:"dest" jsonschema:"The directory to place the Terraform files in"`
Console bool `json:"console" jsonschema:"Dump Terraform files to the console"`
ProjectId StringSliceArgs `json:"projectId" jsonschema:"Limit the export to a single project"`
ProjectName StringSliceArgs `json:"projectName" jsonschema:"Limit the export to a single project"`
RunbookId string `` /* 137-byte string literal not displayed */
RunbookName string `` /* 174-byte string literal not displayed */
LookupProjectDependencies bool `` /* 275-byte string literal not displayed */
LookupProjectLinkTenants bool `` /* 359-byte string literal not displayed */
Stateless bool `json:"stepTemplate" jsonschema:"Create an Octopus step template"`
StatelessAdditionalParams StringSliceArgs `` /* 236-byte string literal not displayed */
StepTemplateName string `json:"stepTemplateName" jsonschema:"Step template name. Only used with the stepTemplate option."`
StepTemplateKey string `` /* 129-byte string literal not displayed */
StepTemplateDescription string `` /* 145-byte string literal not displayed */
IgnoreCacManagedValues bool `` /* 300-byte string literal not displayed */
ExcludeCaCProjectSettings bool `` /* 375-byte string literal not displayed */
BackendBlock string `json:"terraformBackend" jsonschema:"Specifies the backend type to be added to the exported Terraform configuration."`
DetachProjectTemplates bool `json:"detachProjectTemplates" jsonschema:"Detaches any step templates in the exported Terraform."`
DefaultSecretVariableValues bool `` /* 155-byte string literal not displayed */
DummySecretVariableValues bool `` /* 385-byte string literal not displayed */
InlineVariableValues bool `` /* 301-byte string literal not displayed */
ProviderVersion string `json:"providerVersion" jsonschema:"Specifies the Octopus Terraform provider version."`
ExcludeProvider bool `` /* 227-byte string literal not displayed */
IncludeProviderServerDetails bool `` /* 252-byte string literal not displayed */
IncludeOctopusOutputVars bool `` /* 216-byte string literal not displayed */
LimitAttributeLength int `json:"limitAttributeLength" jsonschema:"For internal use only. Limits the length of the attribute names."`
LimitResourceCount int `` /* 522-byte string literal not displayed */
GenerateImportScripts bool `` /* 129-byte string literal not displayed */
IgnoreCacErrors bool `` /* 127-byte string literal not displayed */
OctopusManagedTerraformVars string `` /* 297-byte string literal not displayed */
IgnoreProjectChanges bool `` /* 178-byte string literal not displayed */
IgnoreProjectVariableChanges bool `` /* 316-byte string literal not displayed */
IgnoreProjectGroupChanges bool `` /* 133-byte string literal not displayed */
IgnoreProjectNameChanges bool `` /* 131-byte string literal not displayed */
LookUpDefaultWorkerPools bool `` /* 226-byte string literal not displayed */
IncludeIds bool `` /* 161-byte string literal not displayed */
IncludeSpaceInPopulation bool `` /* 253-byte string literal not displayed */
IncludeDefaultChannel bool `` /* 148-byte string literal not displayed */
ExcludeAllProjectVariables bool `` /* 170-byte string literal not displayed */
ExcludeProjectVariables StringSliceArgs `` /* 163-byte string literal not displayed */
ExcludeProjectVariablesExcept StringSliceArgs `` /* 214-byte string literal not displayed */
ExcludeProjectVariablesRegex StringSliceArgs `` /* 189-byte string literal not displayed */
ExcludeVariableEnvironmentScopes StringSliceArgs `` /* 224-byte string literal not displayed */
ExcludeAllTenantVariables bool `` /* 168-byte string literal not displayed */
ExcludeTenantVariables StringSliceArgs `` /* 162-byte string literal not displayed */
ExcludeTenantVariablesExcept StringSliceArgs `` /* 213-byte string literal not displayed */
ExcludeTenantVariablesRegex StringSliceArgs `` /* 188-byte string literal not displayed */
ExcludeAllSteps bool `` /* 173-byte string literal not displayed */
ExcludeSteps StringSliceArgs `` /* 174-byte string literal not displayed */
ExcludeStepsRegex StringSliceArgs `` /* 200-byte string literal not displayed */
ExcludeStepsExcept StringSliceArgs `` /* 228-byte string literal not displayed */
ExcludeAllChannels bool `` /* 160-byte string literal not displayed */
ExcludeChannels StringSliceArgs `` /* 154-byte string literal not displayed */
ExcludeChannelsRegex StringSliceArgs `` /* 180-byte string literal not displayed */
ExcludeChannelsExcept StringSliceArgs `` /* 196-byte string literal not displayed */
ExcludeInvalidChannels bool `` /* 226-byte string literal not displayed */
ExcludeAllRunbooks bool `` /* 183-byte string literal not displayed */
ExcludeRunbooks StringSliceArgs `` /* 181-byte string literal not displayed */
ExcludeRunbooksRegex StringSliceArgs `` /* 207-byte string literal not displayed */
ExcludeRunbooksExcept StringSliceArgs `` /* 239-byte string literal not displayed */
ExcludeAllTriggers bool `json:"excludeAllTriggers" jsonschema:"Exclude all triggers when exporting a project or space."`
ExcludeTriggers StringSliceArgs `json:"excludeTrigger" jsonschema:"A trigger to be excluded when exporting a single project."`
ExcludeTriggersRegex StringSliceArgs `json:"excludeTriggerRegex" jsonschema:"A trigger to be excluded when exporting a single project based on regex match."`
ExcludeTriggersExcept StringSliceArgs `` /* 148-byte string literal not displayed */
ExcludeLibraryVariableSets StringSliceArgs `` /* 212-byte string literal not displayed */
ExcludeLibraryVariableSetsRegex StringSliceArgs `` /* 238-byte string literal not displayed */
ExcludeLibraryVariableSetsExcept StringSliceArgs `` /* 249-byte string literal not displayed */
ExcludeAllLibraryVariableSets bool `` /* 180-byte string literal not displayed */
ExcludeEnvironments StringSliceArgs `` /* 284-byte string literal not displayed */
ExcludeEnvironmentsRegex StringSliceArgs `` /* 310-byte string literal not displayed */
ExcludeEnvironmentsExcept StringSliceArgs `` /* 310-byte string literal not displayed */
ExcludeAllEnvironments bool `` /* 250-byte string literal not displayed */
ExcludeFeeds StringSliceArgs `` /* 193-byte string literal not displayed */
ExcludeFeedsRegex StringSliceArgs `` /* 219-byte string literal not displayed */
ExcludeFeedsExcept StringSliceArgs `` /* 213-byte string literal not displayed */
ExcludeAllFeeds bool `` /* 160-byte string literal not displayed */
ExcludeProjectGroups StringSliceArgs `` /* 210-byte string literal not displayed */
ExcludeProjectGroupsRegex StringSliceArgs `` /* 236-byte string literal not displayed */
ExcludeProjectGroupsExcept StringSliceArgs `` /* 238-byte string literal not displayed */
ExcludeAllProjectGroups bool `` /* 177-byte string literal not displayed */
ExcludeAccounts StringSliceArgs `` /* 200-byte string literal not displayed */
ExcludeAccountsRegex StringSliceArgs `` /* 226-byte string literal not displayed */
ExcludeAccountsExcept StringSliceArgs `` /* 222-byte string literal not displayed */
ExcludeAllAccounts bool `` /* 166-byte string literal not displayed */
ExcludeCertificates StringSliceArgs `` /* 207-byte string literal not displayed */
ExcludeCertificatesRegex StringSliceArgs `` /* 233-byte string literal not displayed */
ExcludeCertificatesExcept StringSliceArgs `` /* 234-byte string literal not displayed */
ExcludeAllCertificates bool `` /* 174-byte string literal not displayed */
ExcludeLifecycles StringSliceArgs `` /* 203-byte string literal not displayed */
ExcludeLifecyclesRegex StringSliceArgs `` /* 229-byte string literal not displayed */
ExcludeLifecyclesExcept StringSliceArgs `` /* 228-byte string literal not displayed */
ExcludeAllLifecycles bool `` /* 170-byte string literal not displayed */
ExcludeWorkerpools StringSliceArgs `` /* 206-byte string literal not displayed */
ExcludeWorkerpoolsRegex StringSliceArgs `` /* 232-byte string literal not displayed */
ExcludeWorkerpoolsExcept StringSliceArgs `` /* 232-byte string literal not displayed */
ExcludeAllWorkerpools bool `` /* 173-byte string literal not displayed */
ExcludeMachinePolicies StringSliceArgs `` /* 213-byte string literal not displayed */
ExcludeMachinePoliciesRegex StringSliceArgs `` /* 239-byte string literal not displayed */
ExcludeMachinePoliciesExcept StringSliceArgs `` /* 244-byte string literal not displayed */
ExcludeAllMachinePolicies bool `` /* 181-byte string literal not displayed */
ExcludeMachineProxies StringSliceArgs `json:"excludeMachineProxies" jsonschema:"A machine proxy to be excluded when exporting a single project."`
ExcludeMachineProxiesRegex StringSliceArgs `` /* 131-byte string literal not displayed */
ExcludeMachineProxiesExcept StringSliceArgs `` /* 135-byte string literal not displayed */
ExcludeAllMachineProxies bool `json:"excludeAllMachineProxies" jsonschema:"Exclude all machine proxies."`
ExcludeTenantTags StringSliceArgs `` /* 244-byte string literal not displayed */
ExcludeTenantTagSets StringSliceArgs `` /* 196-byte string literal not displayed */
ExcludeTenantTagSetsRegex StringSliceArgs `` /* 170-byte string literal not displayed */
ExcludeTenantTagSetsExcept StringSliceArgs `` /* 176-byte string literal not displayed */
ExcludeAllTenantTagSets bool `` /* 155-byte string literal not displayed */
ExcludeTenants StringSliceArgs `json:"excludeTenants" jsonschema:"Exclude a tenant from being exported."`
ExcludeTenantsRegex StringSliceArgs `json:"excludeTenantsRegex" jsonschema:"Exclude a tenant from being exported based on a regex."`
ExcludeTenantsWithTags StringSliceArgs `` /* 240-byte string literal not displayed */
ExcludeTenantsExcept StringSliceArgs `` /* 206-byte string literal not displayed */
ExcludeAllTenants bool `json:"excludeAllTenants" jsonschema:"Exclude all tenants from being exported."`
ExcludeProjects StringSliceArgs `json:"excludeProjects" jsonschema:"Exclude a project from being exported. This is only used when exporting a space."`
ExcludeProjectsExcept StringSliceArgs `` /* 158-byte string literal not displayed */
ExcludeProjectsRegex StringSliceArgs `` /* 142-byte string literal not displayed */
ExcludeAllProjects bool `json:"excludeAllProjects" jsonschema:"Exclude all projects from being exported. This is only used when exporting a space."`
ExcludeAllTargets bool `` /* 147-byte string literal not displayed */
ExcludeTargets StringSliceArgs `` /* 140-byte string literal not displayed */
ExcludeTargetsRegex StringSliceArgs `` /* 162-byte string literal not displayed */
ExcludeTargetsExcept StringSliceArgs `` /* 281-byte string literal not displayed */
ExcludeTargetsWithNoEnvironments bool `` /* 184-byte string literal not displayed */
ExcludeAllWorkers bool `json:"excludeAllWorkers" jsonschema:"Exclude all workers from being exported."`
ExcludeWorkers StringSliceArgs `json:"excludeWorkers" jsonschema:"Exclude workers from being exported."`
ExcludeWorkersRegex StringSliceArgs `json:"excludeWorkersRegex" jsonschema:"Exclude workers from being exported based on a regex."`
ExcludeWorkersExcept StringSliceArgs `` /* 206-byte string literal not displayed */
ExcludeAllGitCredentials bool `json:"excludeAllGitCredentials" jsonschema:"Exclude all git credentials. Must be used with -excludeCaCProjectSettings."`
ExcludeAllDeploymentFreezes bool `json:"excludeAllDeploymentFreezes" jsonschema:"Exclude all deployment freezes from being exported."`
ExcludeDeploymentFreezes StringSliceArgs `json:"excludeDeploymentFreezes" jsonschema:"Exclude a deployment freeze from being exported."`
ExcludeDeploymentFreezesExcept StringSliceArgs `` /* 144-byte string literal not displayed */
ExcludeDeploymentFreezesRegex StringSliceArgs `json:"excludeDeploymentFreezesRegex" jsonschema:"Exclude a deployment freeze from being exported based on regex match."`
ExcludePlatformHubVersionControl bool `json:"excludePlatformHubVersionControl" jsonschema:"Exclude the Platform Hub version control settings."`
}
func (*Arguments) ConfigureGlobalSettings ¶ added in v0.1.1248
func (*Arguments) GetBackend ¶ added in v0.1.876
GetBackend forces the use of a local backend for stateless exports
func (*Arguments) ValidateExcludeExceptArgs ¶ added in v0.1.1023
ValidateExcludeExceptArgs removes any resource named in an Exclude<ResourceType>Except argument that does not exist in the Octopus instance. This is mostly used when external systems attempt to filter the results but may place incorrect values into the Exclude<ResourceType>Except arguments.
type StringSliceArgs ¶ added in v0.1.1004
type StringSliceArgs []string
func (*StringSliceArgs) Set ¶ added in v0.1.1004
func (i *StringSliceArgs) Set(value string) error
func (*StringSliceArgs) String ¶ added in v0.1.1004
func (i *StringSliceArgs) String() string
Click to show internal directories.
Click to hide internal directories.