args

package
v1.9.33 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 30, 2026 License: Apache-2.0, MIT Imports: 12 Imported by: 0

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,omitempty" jsonschema:"Ignore certificate errors when connecting to the Octopus server."`
	ExperimentalEnableStepTemplates bool            `` /* 211-byte string literal not displayed */
	Profiling                       bool            `json:"profiling,omitempty" jsonschema:"Enable profiling. Run 'pprof -http=:8080 octoterra.prof' to view the results."`
	ExcludeTerraformVariables       bool            `` /* 339-byte string literal not displayed */
	ExcludeSpaceCreation            bool            `` /* 133-byte string literal not displayed */
	ConfigFile                      string          `` /* 135-byte string literal not displayed */
	ConfigPath                      string          `json:"configPath,omitempty" jsonschema:"The path of the configuration file to use. Defaults to the current directory"`
	Version                         bool            `json:"version,omitempty" jsonschema:"Print the version"`
	IgnoreInvalidExcludeExcept      bool            `` /* 480-byte string literal not displayed */
	Url                             string          `` /* 201-byte string literal not displayed */
	ApiKey                          string          `` /* 173-byte string literal not displayed */
	AccessToken                     string          `json:"accessToken,omitempty" jsonschema:"The Octopus access token"`
	UseRedirector                   bool            `json:"useRedirector,omitempty" jsonschema:"Set to true to access the Octopus instance via the redirector"`
	RedirectorHost                  string          `json:"redirectorHost,omitempty" jsonschema:"The hostname of the redirector service"`
	RedirectorServiceApiKey         string          `json:"redirectorServiceApiKey,omitempty" jsonschema:"The service api key of the redirector service"`
	RedirecrtorApiKey               string          `json:"redirecrtorApiKey,omitempty" jsonschema:"The user api key of the redirector service"`
	RedirectorRedirections          string          `json:"redirectorRedirections,omitempty" jsonschema:"The redirection rules for the redirector service"`
	Space                           string          `json:"space,omitempty" jsonschema:"The Octopus space name or ID"`
	Destination                     string          `json:"dest,omitempty" jsonschema:"The directory to place the Terraform files in"`
	Console                         bool            `json:"console,omitempty" jsonschema:"Dump Terraform files to the console"`
	ProjectId                       StringSliceArgs `json:"projectId,omitempty" jsonschema:"Limit the export to a single project"`
	ProjectName                     StringSliceArgs `json:"projectName,omitempty" jsonschema:"Limit the export to a single project"`
	RunbookId                       string          `` /* 147-byte string literal not displayed */
	RunbookName                     string          `` /* 184-byte string literal not displayed */
	LookupProjectDependencies       bool            `` /* 285-byte string literal not displayed */
	LookupProjectLinkTenants        bool            `` /* 369-byte string literal not displayed */
	Stateless                       bool            `json:"stepTemplate,omitempty" jsonschema:"Create an Octopus step template"`
	StatelessAdditionalParams       StringSliceArgs `` /* 246-byte string literal not displayed */
	StepTemplateName                string          `json:"stepTemplateName,omitempty" jsonschema:"Step template name. Only used with the stepTemplate option."`
	StepTemplateKey                 string          `` /* 139-byte string literal not displayed */
	StepTemplateDescription         string          `` /* 155-byte string literal not displayed */
	IgnoreCacManagedValues          bool            `` /* 310-byte string literal not displayed */
	ExcludeCaCProjectSettings       bool            `` /* 385-byte string literal not displayed */
	BackendBlock                    string          `` /* 126-byte string literal not displayed */
	DetachProjectTemplates          bool            `json:"detachProjectTemplates,omitempty" jsonschema:"Detaches any step templates in the exported Terraform."`
	DefaultSecretVariableValues     bool            `` /* 165-byte string literal not displayed */
	DummySecretVariableValues       bool            `` /* 395-byte string literal not displayed */
	InlineVariableValues            bool            `` /* 311-byte string literal not displayed */
	ProviderVersion                 string          `json:"providerVersion,omitempty" jsonschema:"Specifies the Octopus Terraform provider version."`
	ExcludeProvider                 bool            `` /* 237-byte string literal not displayed */
	IncludeProviderServerDetails    bool            `` /* 262-byte string literal not displayed */
	IncludeOctopusOutputVars        bool            `` /* 226-byte string literal not displayed */
	LimitAttributeLength            int             `json:"limitAttributeLength,omitempty" jsonschema:"For internal use only. Limits the length of the attribute names."`
	LimitResourceCount              int             `` /* 532-byte string literal not displayed */
	GenerateImportScripts           bool            `` /* 139-byte string literal not displayed */
	IgnoreCacErrors                 bool            `` /* 137-byte string literal not displayed */

	OctopusManagedTerraformVars string `` /* 307-byte string literal not displayed */

	IgnoreProjectChanges         bool `` /* 188-byte string literal not displayed */
	IgnoreProjectVariableChanges bool `` /* 326-byte string literal not displayed */
	IgnoreProjectGroupChanges    bool `` /* 143-byte string literal not displayed */
	IgnoreProjectNameChanges     bool `` /* 141-byte string literal not displayed */
	LookUpDefaultWorkerPools     bool `` /* 236-byte string literal not displayed */
	IncludeIds                   bool `` /* 171-byte string literal not displayed */
	IncludeSpaceInPopulation     bool `` /* 263-byte string literal not displayed */
	IncludeDefaultChannel        bool `` /* 158-byte string literal not displayed */

	ExcludeAllProjectVariables       bool            `` /* 180-byte string literal not displayed */
	ExcludeProjectVariables          StringSliceArgs `` /* 173-byte string literal not displayed */
	ExcludeProjectVariablesExcept    StringSliceArgs `` /* 224-byte string literal not displayed */
	ExcludeProjectVariablesRegex     StringSliceArgs `` /* 199-byte string literal not displayed */
	ExcludeVariableEnvironmentScopes StringSliceArgs `` /* 234-byte string literal not displayed */

	ExcludeAllTenantVariables    bool            `` /* 178-byte string literal not displayed */
	ExcludeTenantVariables       StringSliceArgs `` /* 172-byte string literal not displayed */
	ExcludeTenantVariablesExcept StringSliceArgs `` /* 223-byte string literal not displayed */
	ExcludeTenantVariablesRegex  StringSliceArgs `` /* 198-byte string literal not displayed */

	ExcludeAllSteps    bool            `` /* 183-byte string literal not displayed */
	ExcludeSteps       StringSliceArgs `` /* 184-byte string literal not displayed */
	ExcludeStepsRegex  StringSliceArgs `` /* 210-byte string literal not displayed */
	ExcludeStepsExcept StringSliceArgs `` /* 238-byte string literal not displayed */

	ExcludeAllChannels     bool            `` /* 170-byte string literal not displayed */
	ExcludeChannels        StringSliceArgs `` /* 164-byte string literal not displayed */
	ExcludeChannelsRegex   StringSliceArgs `` /* 190-byte string literal not displayed */
	ExcludeChannelsExcept  StringSliceArgs `` /* 206-byte string literal not displayed */
	ExcludeInvalidChannels bool            `` /* 236-byte string literal not displayed */

	ExcludeAllRunbooks    bool            `` /* 193-byte string literal not displayed */
	ExcludeRunbooks       StringSliceArgs `` /* 191-byte string literal not displayed */
	ExcludeRunbooksRegex  StringSliceArgs `` /* 217-byte string literal not displayed */
	ExcludeRunbooksExcept StringSliceArgs `` /* 249-byte string literal not displayed */

	ExcludeAllTriggers    bool            `json:"excludeAllTriggers,omitempty" jsonschema:"Exclude all triggers when exporting a project or space."`
	ExcludeTriggers       StringSliceArgs `json:"excludeTrigger,omitempty" jsonschema:"A trigger to be excluded when exporting a single project."`
	ExcludeTriggersRegex  StringSliceArgs `` /* 128-byte string literal not displayed */
	ExcludeTriggersExcept StringSliceArgs `` /* 158-byte string literal not displayed */

	ExcludeLibraryVariableSets       StringSliceArgs `` /* 222-byte string literal not displayed */
	ExcludeLibraryVariableSetsRegex  StringSliceArgs `` /* 248-byte string literal not displayed */
	ExcludeLibraryVariableSetsExcept StringSliceArgs `` /* 259-byte string literal not displayed */
	ExcludeAllLibraryVariableSets    bool            `` /* 190-byte string literal not displayed */

	ExcludeEnvironments       StringSliceArgs `` /* 294-byte string literal not displayed */
	ExcludeEnvironmentsRegex  StringSliceArgs `` /* 320-byte string literal not displayed */
	ExcludeEnvironmentsExcept StringSliceArgs `` /* 320-byte string literal not displayed */
	ExcludeAllEnvironments    bool            `` /* 260-byte string literal not displayed */

	ExcludeFeeds       StringSliceArgs `` /* 203-byte string literal not displayed */
	ExcludeFeedsRegex  StringSliceArgs `` /* 229-byte string literal not displayed */
	ExcludeFeedsExcept StringSliceArgs `` /* 223-byte string literal not displayed */
	ExcludeAllFeeds    bool            `` /* 170-byte string literal not displayed */

	ExcludeProjectGroups       StringSliceArgs `` /* 220-byte string literal not displayed */
	ExcludeProjectGroupsRegex  StringSliceArgs `` /* 246-byte string literal not displayed */
	ExcludeProjectGroupsExcept StringSliceArgs `` /* 248-byte string literal not displayed */
	ExcludeAllProjectGroups    bool            `` /* 187-byte string literal not displayed */

	ExcludeAccounts       StringSliceArgs `` /* 210-byte string literal not displayed */
	ExcludeAccountsRegex  StringSliceArgs `` /* 236-byte string literal not displayed */
	ExcludeAccountsExcept StringSliceArgs `` /* 232-byte string literal not displayed */
	ExcludeAllAccounts    bool            `` /* 176-byte string literal not displayed */

	ExcludeCertificates       StringSliceArgs `` /* 217-byte string literal not displayed */
	ExcludeCertificatesRegex  StringSliceArgs `` /* 243-byte string literal not displayed */
	ExcludeCertificatesExcept StringSliceArgs `` /* 244-byte string literal not displayed */
	ExcludeAllCertificates    bool            `` /* 184-byte string literal not displayed */

	ExcludeLifecycles       StringSliceArgs `` /* 213-byte string literal not displayed */
	ExcludeLifecyclesRegex  StringSliceArgs `` /* 239-byte string literal not displayed */
	ExcludeLifecyclesExcept StringSliceArgs `` /* 238-byte string literal not displayed */
	ExcludeAllLifecycles    bool            `` /* 180-byte string literal not displayed */

	ExcludeWorkerpools       StringSliceArgs `` /* 216-byte string literal not displayed */
	ExcludeWorkerpoolsRegex  StringSliceArgs `` /* 242-byte string literal not displayed */
	ExcludeWorkerpoolsExcept StringSliceArgs `` /* 242-byte string literal not displayed */
	ExcludeAllWorkerpools    bool            `` /* 183-byte string literal not displayed */

	ExcludeMachinePolicies       StringSliceArgs `` /* 223-byte string literal not displayed */
	ExcludeMachinePoliciesRegex  StringSliceArgs `` /* 249-byte string literal not displayed */
	ExcludeMachinePoliciesExcept StringSliceArgs `` /* 254-byte string literal not displayed */
	ExcludeAllMachinePolicies    bool            `` /* 191-byte string literal not displayed */

	ExcludeMachineProxies       StringSliceArgs `json:"excludeMachineProxies,omitempty" jsonschema:"A machine proxy to be excluded when exporting a single project."`
	ExcludeMachineProxiesRegex  StringSliceArgs `` /* 141-byte string literal not displayed */
	ExcludeMachineProxiesExcept StringSliceArgs `` /* 145-byte string literal not displayed */
	ExcludeAllMachineProxies    bool            `json:"excludeAllMachineProxies,omitempty" jsonschema:"Exclude all machine proxies."`

	ExcludeTenantTags StringSliceArgs `` /* 254-byte string literal not displayed */

	ExcludeTenantTagSets       StringSliceArgs `` /* 206-byte string literal not displayed */
	ExcludeTenantTagSetsRegex  StringSliceArgs `` /* 180-byte string literal not displayed */
	ExcludeTenantTagSetsExcept StringSliceArgs `` /* 186-byte string literal not displayed */
	ExcludeAllTenantTagSets    bool            `` /* 165-byte string literal not displayed */

	ExcludeTenants         StringSliceArgs `json:"excludeTenants,omitempty" jsonschema:"Exclude a tenant from being exported."`
	ExcludeTenantsRegex    StringSliceArgs `json:"excludeTenantsRegex,omitempty" jsonschema:"Exclude a tenant from being exported based on a regex."`
	ExcludeTenantsWithTags StringSliceArgs `` /* 250-byte string literal not displayed */
	ExcludeTenantsExcept   StringSliceArgs `` /* 216-byte string literal not displayed */
	ExcludeAllTenants      bool            `json:"excludeAllTenants,omitempty" jsonschema:"Exclude all tenants from being exported."`

	ExcludeProjects       StringSliceArgs `` /* 126-byte string literal not displayed */
	ExcludeProjectsExcept StringSliceArgs `` /* 168-byte string literal not displayed */
	ExcludeProjectsRegex  StringSliceArgs `` /* 152-byte string literal not displayed */
	ExcludeAllProjects    bool            `` /* 132-byte string literal not displayed */

	ExcludeAllTargets                bool            `` /* 157-byte string literal not displayed */
	ExcludeTargets                   StringSliceArgs `` /* 150-byte string literal not displayed */
	ExcludeTargetsRegex              StringSliceArgs `` /* 172-byte string literal not displayed */
	ExcludeTargetsExcept             StringSliceArgs `` /* 291-byte string literal not displayed */
	ExcludeTargetsWithNoEnvironments bool            `` /* 194-byte string literal not displayed */

	ExcludeAllWorkers    bool            `json:"excludeAllWorkers,omitempty" jsonschema:"Exclude all workers from being exported."`
	ExcludeWorkers       StringSliceArgs `json:"excludeWorkers,omitempty" jsonschema:"Exclude workers from being exported."`
	ExcludeWorkersRegex  StringSliceArgs `json:"excludeWorkersRegex,omitempty" jsonschema:"Exclude workers from being exported based on a regex."`
	ExcludeWorkersExcept StringSliceArgs `` /* 216-byte string literal not displayed */

	ExcludeAllGitCredentials bool `` /* 129-byte string literal not displayed */

	ExcludeAllDeploymentFreezes    bool            `json:"excludeAllDeploymentFreezes,omitempty" jsonschema:"Exclude all deployment freezes from being exported."`
	ExcludeDeploymentFreezes       StringSliceArgs `json:"excludeDeploymentFreezes,omitempty" jsonschema:"Exclude a deployment freeze from being exported."`
	ExcludeDeploymentFreezesExcept StringSliceArgs `` /* 154-byte string literal not displayed */
	ExcludeDeploymentFreezesRegex  StringSliceArgs `` /* 129-byte string literal not displayed */

	ExcludePlatformHubVersionControl bool `json:"excludePlatformHubVersionControl,omitempty" jsonschema:"Exclude the Platform Hub version control settings."`
}

func ParseArgs

func ParseArgs(args []string) (Arguments, string, error)

func (*Arguments) ConfigureGlobalSettings added in v0.1.1248

func (arguments *Arguments) ConfigureGlobalSettings() error

func (*Arguments) GetBackend added in v0.1.876

func (arguments *Arguments) GetBackend() string

GetBackend forces the use of a local backend for stateless exports

func (*Arguments) ValidateExcludeExceptArgs added in v0.1.1023

func (arguments *Arguments) ValidateExcludeExceptArgs() (funcErr error)

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL