update

package
v1.22.0 Latest Latest
Warning

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

Go to latest
Published: Nov 11, 2026 License: Apache-2.0 Imports: 38 Imported by: 0

Documentation

Overview

Package update contains the commands for updating resources.

Index

Constants

View Source
const BuildTrigger = "BUILD_TRIGGER"

BuildTrigger is used to request a retry-build for the application.

View Source
const ReleaseTrigger = "RELEASE_TRIGGER"

ReleaseTrigger is used to request a new release for the application.

Variables

This section is empty.

Functions

func BucketKongVars

func BucketKongVars() kong.Vars

Types

type Cmd

type Cmd struct {
	Application         applicationCmd       `cmd:"" group:"update-apps" name:"application" aliases:"app,application" help:"Update an existing deplo.io Application."`
	APIServiceAccount   apiServiceAccountCmd `cmd:"" group:"update-access" name:"apiserviceaccount" aliases:"asa" help:"Update an API Service Account."`
	ProjectConfig       configCmd            `cmd:"" group:"update-apps" name:"project-config" aliases:"config" help:"Update an existing deplo.io Project Configuration."`
	Project             projectCmd           `cmd:"" group:"update-access" name:"project"  help:"Update an existing Project."`
	MySQL               mySQLCmd             `cmd:"" group:"update-storage" name:"mysql" help:"Update an existing MySQL instance."`
	MySQLDatabase       mysqlDatabaseCmd     `cmd:"" group:"update-storage" name:"mysqldatabase" help:"Update an existing MySQL database."`
	Postgres            postgresCmd          `cmd:"" group:"update-storage" name:"postgres" help:"Update an existing PostgreSQL instance."`
	PostgresDatabase    postgresDatabaseCmd  `cmd:"" group:"update-storage" name:"postgresdatabase" help:"Update an existing PostgreSQL database."`
	KeyValueStore       keyValueStoreCmd     `cmd:"" group:"update-storage" name:"keyvaluestore" aliases:"kvs" help:"Update an existing KeyValueStore instance."`
	OpenSearch          openSearchCmd        `cmd:"" group:"update-storage" name:"opensearch" aliases:"os" help:"Update an existing OpenSearch cluster."`
	CloudVirtualMachine cloudVMCmd           `cmd:"" group:"update-infra" name:"cloudvirtualmachine" aliases:"cloudvm" help:"Update a CloudVM."`
	ServiceConnection   serviceConnectionCmd `cmd:"" group:"update-network" name:"serviceconnection" aliases:"sc" help:"Update a ServiceConnection."`
	StaticEgress        staticEgressCmd      `cmd:"" group:"update-network" name:"staticegress" aliases:"se" help:"Update a StaticEgress."`
	BucketUser          bucketUserCmd        `cmd:"" group:"update-storage" name:"bucketuser" aliases:"bu" help:"Update a BucketUser."`
	Bucket              bucketCmd            `cmd:"" group:"update-storage" name:"bucket" help:"Update a Bucket."`
	Grafana             grafanaCmd           `cmd:"" group:"update-observability" name:"grafana" help:"Update an existing Grafana instance."`
}

type CredentialsResetFlags

type CredentialsResetFlags struct {
	ResetCredentials bool          `help:"Generate new credentials. The current credentials stop working, every client using them has to be updated."`
	Force            bool          `help:"Do not ask for confirmation before resetting the credentials."`
	Wait             bool          `` /* 138-byte string literal not displayed */
	WaitTimeout      time.Duration `` /* 142-byte string literal not displayed */
	// contains filtered or unexported fields
}

CredentialsResetFlags are the flags to reset the credentials of a resource whose controller generates new credentials when its connection secret is deleted. Set credentials_wait_timeout to change the default of the wait timeout, e.g. for resources which take longer to apply the new credentials.

It has to be exported so that Kong picks up the flags of the embedded struct.

func (*CredentialsResetFlags) BeforeApply

func (f *CredentialsResetFlags) BeforeApply(kctx *kong.Context) error

BeforeApply stores the name of the selected update sub-command to suggest the get sub-command retrieving the new credentials.

type DatabaseSSHKeysFlags

type DatabaseSSHKeysFlags struct {
	OptionalSSHKeysFlags

	// Deprecated Flags
	SSHKeysFile *os.File `hidden:"" completion-predictor:"local:file" help:"Deprecated, use --ssh-keys-from-files instead."`
}

DatabaseSSHKeysFlags declares the SSH public key flags of the database update commands, including the deprecated --ssh-keys-file which the repeatable --ssh-keys-from-files replaces.

func (DatabaseSSHKeysFlags) SSHKeysSet

func (f DatabaseSSHKeysFlags) SSHKeysSet() bool

SSHKeysSet reports whether one of the flags was passed at all.

func (DatabaseSSHKeysFlags) StorageKeys

func (f DatabaseSSHKeysFlags) StorageKeys(w *format.Writer) ([]storage.SSHKey, error)

StorageKeys returns the validated SSH public keys of all three flags, in the order --ssh-keys, --ssh-keys-from-files and --ssh-keys-file.

type OptionalSSHKeysFlags

type OptionalSSHKeysFlags struct {
	// sep:"none" keeps Kong from splitting a value on commas,
	// which would tear apart the options of an authorized_keys line.
	// Repeat the flag or separate the keys by newlines to pass more than one.
	SSHKeys          []string   `` /* 277-byte string literal not displayed */
	SSHKeysFromFiles []*os.File `` /* 205-byte string literal not displayed */
}

OptionalSSHKeysFlags is sshkey.SSHKeysFlags for the update commands, where a flag which was not passed has to be told apart from one which was passed an empty value in order to clear the configured keys. It is embedded and described just like sshkey.SSHKeysFlags.

func (OptionalSSHKeysFlags) Keys

func (f OptionalSSHKeysFlags) Keys(w *format.Writer, prefix string) ([]string, error)

Keys returns the validated SSH public keys of --<prefix>ssh-keys followed by those of --<prefix>ssh-keys-from-files, in that order.

func (OptionalSSHKeysFlags) SSHKeysSet

func (f OptionalSSHKeysFlags) SSHKeysSet() bool

SSHKeysSet reports whether one of the flags was passed at all. If it is false the keys which are already configured have to be kept, while SSHKeysSet together with no keys asks for the configured keys to be removed, which is what passing --ssh-keys= does: sep:"none" makes Kong decode the empty value into a single empty entry, telling the flag apart from one which was never passed.

type ResourceCmd

type ResourceCmd struct {
	format.Writer `kong:"-"`
	format.Reader `kong:"-"`
	Name          string `arg:"" completion-predictor:"client:resource_name" help:"Name of the resource to update."`
}

ResourceCmd is the shared base for the update sub-commands.

It has to be exported so that Kong initializes the embedded format.Writer, see format.Writer.BeforeApply.

func (*ResourceCmd) BeforeApply

func (cmd *ResourceCmd) BeforeApply(streams format.IOStreams) error

BeforeApply initializes Writer and Reader from the bound format.IOStreams.

Jump to

Keyboard shortcuts

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