options

Documentation

Index

• type BareDeployOptions
• type ConfigureOptions
• type DebugOptions
• type DebugShowConfigOptions
• type DeployOptions
• type DockerDeployOptions
  • func (o *DockerDeployOptions) Validate() error
• type DockerStopOptions
• type KubernetesDeployOptions
• type KubernetesStopOptions
• type Options
• type ResourceCreateOptions
  • func (o *ResourceCreateOptions) Validate() error
• type ResourceDeleteOptions
• type ResourceGetOptions
• type ResourceListOptions
  • func (o *ResourceListOptions) Validate() error
• type ResourceOptions
• type ResourceUpdateOptions
  • func (o *ResourceUpdateOptions) Validate() error
• type SSLModifyOptions
  • func (o *SSLModifyOptions) Validate() error
• type StopOptions

Types

type BareDeployOptions

type BareDeployOptions struct {
	// APISIXVersion specifies the APISIX version to deploy.
	APISIXVersion string
	// APISIXBinPath specifies the APISIX binary file path.
	APISIXBinPath string
	// Reload indicates if skip the deployment and just try to reload APISIX.
	Reload bool
	// Upgrade indicates if the current try is for upgrading Apache APISIX on
	// bare metal
	Upgrade bool
}

BareDeployOptions contains options for the bare metal deployment command.

type ConfigureOptions

type ConfigureOptions struct {
	// Addr is the address of the API7 Cloud server.
	Addr string
	// Profile is the name of the profile to use.
	Profile string
	// Default indicates if the profile should be set as default.
	Default bool
	// AccessToken is the access token of the API7 Cloud server.
	AccessToken string
}

ConfigureOptions contains options for `cloud-cli configure` command

type DebugOptions

type DebugOptions struct {
	// ShowConfig contains options for `cloud-cli debug show-config` command.
	ShowConfig DebugShowConfigOptions
}

DebugOptions contains options for `cloud-cli debug` command.

type DebugShowConfigOptions

type DebugShowConfigOptions struct {
	// ID is the API7 Cloud resource id.
	ID cloud.ID
}

DebugShowConfigOptions contains options for `cloud-cli debug show-config` command.

type DeployOptions

type DeployOptions struct {
	// Name is an identifier of this deployment.
	// It'll be container name if deploy on Docker;
	// It'll be the Helm release name if deploy on Kubernetes;
	// It'll be noop if deploy on Bare metal.
	Name string
	// APISIXInstanceID specifies the ID of the APISIX instance to deploy.
	// When this field is empty, the instance ID will be generated automatically.
	APISIXInstanceID string `validate:"min=1 max=128"`
	// APISIXConfigFile is the path to the APISIX configuration file.
	APISIXConfigFile string
	// Docker contains the options for the deploy docker command.
	Docker DockerDeployOptions
	// Bare contains the options for the bare metal deployment command.
	Bare BareDeployOptions
	// KubernetesDeployOptions contains options for the kubernetes or helm command.
	Kubernetes KubernetesDeployOptions
}

DeployOptions contains options for the deploy command.

type DockerDeployOptions

type DockerDeployOptions struct {
	// APISIXImage is the name of the APISIX image to deploy.
	APISIXImage string `validate:"image"`
	// DockerRunArgs contains a series of arguments to pass to the docker run command.
	DockerRunArgs []string
	// DockerCLIPath is the filepath of the docker command.
	DockerCLIPath string
	// Specify the host port for HTTP
	HTTPHostPort int
	// Specify the host port for HTTPS
	HTTPSHostPort int
	// Specify the filesystem path of the host directory to mount into the container for
	// saving the APISIX local configuration cache.
	LocalCacheBindPath string
}

DockerDeployOptions contains options for the deploy docker command.

func (*DockerDeployOptions) Validate

func (o *DockerDeployOptions) Validate() error

Validate validates the docker deploy options.

type DockerStopOptions

type DockerStopOptions struct {
	// DockerCLIPath is the filepath of the docker command.
	DockerCLIPath string
}

DockerStopOptions contains options for the stop docker command.

type KubernetesDeployOptions

type KubernetesDeployOptions struct {
	// Namespace is the name space of kubernetes
	Namespace string
	// APISIXImage is the name of the APISIX image to deploy.
	APISIXImage string `validate:"image"`
	// APISIXImageRepo is the APISIXImage name
	APISIXImageRepo string
	// APISIXImageTag is the APISIXImage tag
	APISIXImageTag string
	// ReplicaCount is the pod replica count
	ReplicaCount uint
	// HelmInstallArgs contains a series of arguments to pass to the helm install command.
	HelmInstallArgs []string
	// KubectlCLIPath is the filepath of the kubectl command.
	KubectlCLIPath string
	// HelmCLIPath is the filepath of the helm command.
	HelmCLIPath string
	// LocalCachePVC is the PVC for saving the local configuration cache.
	LocalCachePVC string
}

KubernetesDeployOptions contains options for the kubectl or helm command.

type KubernetesStopOptions

type KubernetesStopOptions struct {
	// NameSpace is the name space of kubernetes
	NameSpace string
	// HelmUnInstallArgs contains a series of arguments to pass to the helm uninstall command.
	HelmUnInstallArgs []string
	// KubectlCLIPath is the filepath of the kubectl command.
	KubectlCLIPath string
	// HelmCLIPath is the filepath of the helm command.
	HelmCLIPath string
}

KubernetesStopOptions contains options for the kubectl or helm command.

type Options

type Options struct {
	// Verbose controls if the output should be elaborate.
	Verbose bool
	// DryRun controls if all the actions should be simulated instead of executed.
	DryRun bool
	// Profile is the name of the profile to use.
	Profile string
	// Deploy contains the options for the deploy command.
	Deploy DeployOptions
	// Stop contains the options for the stop command.
	Stop StopOptions
	// Debug contains the options for the debug command.
	Debug DebugOptions
	// Resource contains the options for the resource command.
	Resource ResourceOptions
	// Configure contains the options for the configure command.
	Configure ConfigureOptions
}

Options contains all options.

var (
	// Global contains all options.
	Global Options
)

type ResourceCreateOptions

type ResourceCreateOptions struct {
	// Specify the kind of resource.
	Kind string
	// Specify the SSL create options.
	SSL SSLModifyOptions
	// Labels indicates a series of resource labels.
	Labels []string
	// FromFile indicates a filepath which contains the resource definition.
	FromFile string
}

ResourceCreateOptions contains options for the resource creation.

func (*ResourceCreateOptions) Validate

func (o *ResourceCreateOptions) Validate() error

Validate validates the ResourceCreateOptions.

type ResourceDeleteOptions

type ResourceDeleteOptions struct {
	Kind      string
	ID        string
	ServiceID string
}

ResourceDeleteOptions contains options for `cloud-cli resource delete` command.

type ResourceGetOptions

type ResourceGetOptions struct {
	// Specify the kind of resource
	Kind string
	// Specify the ID of resource
	ID string
	// Specify the service ID of resource
	ServiceID string
}

ResourceGetOptions contains options for `cloud-cli resource get` command.

type ResourceListOptions

type ResourceListOptions struct {
	// Specify the kind of resource
	Kind string
	// Specify the amount of data to be listed
	Limit int
	// Specifies how much data to skip ahead
	Skip int
	// Specify the ID of service
	ServiceID string
}

ResourceListOptions contains options for `cloud-cli resource list` command.

func (*ResourceListOptions) Validate

func (o *ResourceListOptions) Validate() error

Validate validates the docker deploy options.

type ResourceOptions

type ResourceOptions struct {
	List   ResourceListOptions
	Get    ResourceGetOptions
	Delete ResourceDeleteOptions
	Create ResourceCreateOptions
	Update ResourceUpdateOptions
}

ResourceOptions indicates the options for the resource operation.

type ResourceUpdateOptions

type ResourceUpdateOptions struct {
	// ID specifies the resource ID.
	ID string
	// Kind specifies the kind of resource.
	Kind string
	// SSL specifies the SSL create options.
	SSL SSLModifyOptions
	// Labels indicates a series of resource labels.
	Labels []string
	// FromFile indicates a filepath which contains the resource definition.
	FromFile string
}

ResourceUpdateOptions contains options for the resource update.

func (*ResourceUpdateOptions) Validate

func (o *ResourceUpdateOptions) Validate() error

Validate validates the ResourceCreateOptions.

type SSLModifyOptions

type SSLModifyOptions struct {
	CertFile   string
	PKeyFile   string
	CACertFile string
	Type       cloud.CertificateType
}

SSLModifyOptions contains the modify options for ssl.

func (*SSLModifyOptions) Validate

func (o *SSLModifyOptions) Validate() error

type StopOptions

type StopOptions struct {
	// Name is an identifier of this deployment.
	// It'll be container name if deploy on Docker;
	// It'll be the Helm release name if deploy on Kubernetes;
	// It'll be noop if deploy on Bare metal.
	Name string
	// Remove controls whether to delete containers in docker
	Remove bool
	// Docker contains the options for the stop docker command.
	Docker DockerStopOptions
	// Kubernetes contains options for the kubectl or helm command.
	Kubernetes KubernetesStopOptions
}

StopOptions contains options for the stop command.