Documentation
¶
Overview ¶
Commands for Cobra based command line tools.
Index ¶
- type AdminDiagnosticsAnalyzeOptions
- type AdminDiagnosticsCollectOptions
- type ClusterConfigViewOptions
- type ClusterPortalDeleteOptions
- type ClusterPortalExportOptions
- type ClusterPortalListOptions
- type ClusterPortalOpenOptions
- type ClusterPortalPasswordOptions
- type ClusterSessionExtendOptions
- type ClusterSessionListOptions
- type ClusterSessionStatusOptions
- type ClusterSessionTerminateOptions
- type ClusterWorkshopDeleteOptions
- type ClusterWorkshopDeployOptions
- type ClusterWorkshopRequestOptions
- type ClusterWorkshopServeOptions
- type ClusterWorkshopUpdateOptions
- type ClusterWorkshopsListOptions
- type DockerExtensionBackendOptions
- type DockerWorkshopDeleteOptions
- type DockerWorkshopDeployOptions
- type DockerWorkshopDetails
- type DockerWorkshopLogsOptions
- type DockerWorkshopOpenOptions
- type DockerWorkshopsBackend
- type DockerWorkshopsManager
- func (m *DockerWorkshopsManager) ClearWorkshopStatus(name string)
- func (m *DockerWorkshopsManager) DeleteWorkshop(name string, stdout io.Writer, stderr io.Writer) error
- func (m *DockerWorkshopsManager) DeployWorkshop(o *DockerWorkshopDeployOptions, stdout io.Writer, stderr io.Writer) (string, error)
- func (m *DockerWorkshopsManager) ListWorkhops() ([]DockerWorkshopDetails, error)
- func (m *DockerWorkshopsManager) SetWorkshopStatus(name string, url string, source string, status string)
- func (m *DockerWorkshopsManager) WorkshopStatus(name string) (DockerWorkshopDetails, bool)
- type FilesRenderOptions
- type KubeconfigOptions
- type LocalClusterCreateOptions
- type LocalClusterDeleteOptions
- type LocalConfigExplainOptions
- type LocalConfigInitOptions
- type LocalConfigViewOptions
- type LocalMirrorDeleteOptions
- type LocalMirrorDeployOptions
- type LocalRegistryDeleteOptions
- type LocalRegistryDeployOptions
- type LocalRegistryPruneOptions
- type LocalResolverDeployOptions
- type LocalResolverUpdateOptions
- type LocalSecretsAddCaOptions
- type LocalSecretsAddDockerRegistryOptions
- type LocalSecretsAddGenericOptions
- type LocalSecretsAddTlsOptions
- type LocalSecretsImportOptions
- type LocalSecretsListOptions
- type LocalSecretsRemoveOptions
- type LocalSecretsSyncOptions
- type LocalSecretsViewOptions
- type LookupConfigOptions
- type PlatformDeleteOptions
- type PlatformDeployOptions
- type PlatformRenderOptions
- type ProjectInfo
- func (p *ProjectInfo) NewAdminCmdGroup() *cobra.Command
- func (p *ProjectInfo) NewAdminDiagnosticsAnalyzeCmd() *cobra.Command
- func (p *ProjectInfo) NewAdminDiagnosticsCmdGroup() *cobra.Command
- func (p *ProjectInfo) NewAdminDiagnosticsCollectCmd() *cobra.Command
- func (p *ProjectInfo) NewAdminLookupCmdGroup() *cobra.Command
- func (p *ProjectInfo) NewAdminLookupKubeconfigCmd() *cobra.Command
- func (p *ProjectInfo) NewAdminPlatformCmdGroup() *cobra.Command
- func (p *ProjectInfo) NewAdminPlatformDeleteCmd() *cobra.Command
- func (p *ProjectInfo) NewAdminPlatformDeployCmd() *cobra.Command
- func (p *ProjectInfo) NewAdminPlatformRenderCmd() *cobra.Command
- func (p *ProjectInfo) NewClusterCmdGroup() *cobra.Command
- func (p *ProjectInfo) NewClusterPortalCmdGroup() *cobra.Command
- func (p *ProjectInfo) NewClusterPortalCreateCmd() *cobra.Command
- func (p *ProjectInfo) NewClusterPortalDeleteCmd() *cobra.Command
- func (p *ProjectInfo) NewClusterPortalExportCmd() *cobra.Command
- func (p *ProjectInfo) NewClusterPortalListCmd() *cobra.Command
- func (p *ProjectInfo) NewClusterPortalOpenCmd() *cobra.Command
- func (p *ProjectInfo) NewClusterPortalPasswordCmd() *cobra.Command
- func (p *ProjectInfo) NewClusterSessionCmdGroup() *cobra.Command
- func (p *ProjectInfo) NewClusterSessionExtendCmd() *cobra.Command
- func (p *ProjectInfo) NewClusterSessionListCmd() *cobra.Command
- func (p *ProjectInfo) NewClusterSessionStatusCmd() *cobra.Command
- func (p *ProjectInfo) NewClusterSessionTerminateCmd() *cobra.Command
- func (p *ProjectInfo) NewClusterWorkshopCmdGroup() *cobra.Command
- func (p *ProjectInfo) NewClusterWorkshopDeleteCmd() *cobra.Command
- func (p *ProjectInfo) NewClusterWorkshopDeployCmd() *cobra.Command
- func (p *ProjectInfo) NewClusterWorkshopListCmd() *cobra.Command
- func (p *ProjectInfo) NewClusterWorkshopRequestCmd() *cobra.Command
- func (p *ProjectInfo) NewClusterWorkshopServeCmd() *cobra.Command
- func (p *ProjectInfo) NewClusterWorkshopUpdateCmd() *cobra.Command
- func (p *ProjectInfo) NewDockerCmdGroup() *cobra.Command
- func (p *ProjectInfo) NewDockerExtensionBackendCmd() *cobra.Command
- func (p *ProjectInfo) NewDockerExtensionCmdGroup() *cobra.Command
- func (p *ProjectInfo) NewDockerWorkshopCmdGroup() *cobra.Command
- func (p *ProjectInfo) NewDockerWorkshopDeleteCmd() *cobra.Command
- func (p *ProjectInfo) NewDockerWorkshopDeployCmd() *cobra.Command
- func (p *ProjectInfo) NewDockerWorkshopListCmd() *cobra.Command
- func (p *ProjectInfo) NewDockerWorkshopLogsCmd() *cobra.Command
- func (p *ProjectInfo) NewDockerWorkshopOpenCmd() *cobra.Command
- func (p *ProjectInfo) NewEducatesCmdGroup() *cobra.Command
- func (p *ProjectInfo) NewLocalClusterCmdGroup() *cobra.Command
- func (p *ProjectInfo) NewLocalClusterCreateCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalClusterDeleteCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalClusterStartCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalClusterStatusCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalClusterStopCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalCmdGroup() *cobra.Command
- func (p *ProjectInfo) NewLocalConfigCmdGroup() *cobra.Command
- func (p *ProjectInfo) NewLocalConfigEditCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalConfigExplainCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalConfigGetCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalConfigInitCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalConfigSetCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalConfigViewCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalMirrorCmdGroup() *cobra.Command
- func (p *ProjectInfo) NewLocalMirrorDeleteCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalMirrorDeployCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalMirrorListCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalRegistryCmdGroup() *cobra.Command
- func (p *ProjectInfo) NewLocalRegistryDeleteCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalRegistryDeployCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalRegistryPruneCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalResolverCmdGroup() *cobra.Command
- func (p *ProjectInfo) NewLocalResolverDeleteCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalResolverDeployCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalResolverUpdateCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalSecretsAddCaCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalSecretsAddCmdGroup() *cobra.Command
- func (p *ProjectInfo) NewLocalSecretsAddDockerRegistryCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalSecretsAddGenericCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalSecretsAddTlsCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalSecretsCmdGroup() *cobra.Command
- func (p *ProjectInfo) NewLocalSecretsExportCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalSecretsImportCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalSecretsListCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalSecretsRemoveCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalSecretsSyncCmd() *cobra.Command
- func (p *ProjectInfo) NewLocalSecretsViewCmd() *cobra.Command
- func (p *ProjectInfo) NewPackageCmdGroup() *cobra.Command
- func (p *ProjectInfo) NewPackagePublishCmd() *cobra.Command
- func (p *ProjectInfo) NewProjectCmdGroup() *cobra.Command
- func (p *ProjectInfo) NewProjectDocsCmdGroup() *cobra.Command
- func (p *ProjectInfo) NewProjectDocsOpenCmd() *cobra.Command
- func (p *ProjectInfo) NewProjectVersionCmd() *cobra.Command
- func (p *ProjectInfo) NewTemplateCmdGroup() *cobra.Command
- func (p *ProjectInfo) NewTemplateListCmd() *cobra.Command
- func (p *ProjectInfo) NewTunnelCmdGroup() *cobra.Command
- func (p *ProjectInfo) NewTunnelConnectCmd() *cobra.Command
- func (p *ProjectInfo) NewWorkshopCmdGroup() *cobra.Command
- func (p *ProjectInfo) NewWorkshopExportCmd() *cobra.Command
- func (p *ProjectInfo) NewWorkshopNewCmd() *cobra.Command
- func (p *ProjectInfo) NewWorkshopPublishCmd() *cobra.Command
- func (p *ProjectInfo) NewWorkshopRenderCmd() *cobra.Command
- type ProjectVersionOptions
- type TunnelConnectOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AdminDiagnosticsAnalyzeOptions ¶
func (*AdminDiagnosticsAnalyzeOptions) Run ¶
func (o *AdminDiagnosticsAnalyzeOptions) Run() error
type AdminDiagnosticsCollectOptions ¶
type AdminDiagnosticsCollectOptions struct {
KubeconfigOptions
Dest string
Verbose bool
}
func (*AdminDiagnosticsCollectOptions) Run ¶
func (o *AdminDiagnosticsCollectOptions) Run() error
type ClusterConfigViewOptions ¶
type ClusterConfigViewOptions struct {
KubeconfigOptions
Portal string
Hostname string
Repository string
Capacity uint
Password string
ThemeName string
CookieDomain string
Labels []string
}
func (*ClusterConfigViewOptions) Run ¶
func (o *ClusterConfigViewOptions) Run(isPasswordSet bool) error
type ClusterPortalDeleteOptions ¶
type ClusterPortalDeleteOptions struct {
KubeconfigOptions
Portal string
}
func (*ClusterPortalDeleteOptions) Run ¶
func (o *ClusterPortalDeleteOptions) Run() error
type ClusterPortalExportOptions ¶
type ClusterPortalExportOptions struct {
KubeconfigOptions
Portal string
AsFiles string
Repository string
WorkshopVersion string
}
func (*ClusterPortalExportOptions) Run ¶
func (o *ClusterPortalExportOptions) Run() error
type ClusterPortalListOptions ¶
type ClusterPortalListOptions struct {
KubeconfigOptions
}
func (*ClusterPortalListOptions) Run ¶
func (o *ClusterPortalListOptions) Run() error
type ClusterPortalOpenOptions ¶
type ClusterPortalOpenOptions struct {
KubeconfigOptions
Admin bool
Portal string
}
func (*ClusterPortalOpenOptions) Run ¶
func (o *ClusterPortalOpenOptions) Run() error
type ClusterPortalPasswordOptions ¶
type ClusterPortalPasswordOptions struct {
KubeconfigOptions
Admin bool
Portal string
}
func (*ClusterPortalPasswordOptions) Run ¶
func (o *ClusterPortalPasswordOptions) Run() error
type ClusterSessionExtendOptions ¶
type ClusterSessionExtendOptions struct {
KubeconfigOptions
Portal string
Name string
}
func (*ClusterSessionExtendOptions) Run ¶
func (o *ClusterSessionExtendOptions) Run() error
type ClusterSessionListOptions ¶
type ClusterSessionListOptions struct {
KubeconfigOptions
Portal string
Environment string
}
func (*ClusterSessionListOptions) Run ¶
func (o *ClusterSessionListOptions) Run() error
type ClusterSessionStatusOptions ¶
type ClusterSessionStatusOptions struct {
KubeconfigOptions
Portal string
Name string
}
func (*ClusterSessionStatusOptions) Run ¶
func (o *ClusterSessionStatusOptions) Run() error
type ClusterSessionTerminateOptions ¶
type ClusterSessionTerminateOptions struct {
KubeconfigOptions
Portal string
Name string
}
func (*ClusterSessionTerminateOptions) Run ¶
func (o *ClusterSessionTerminateOptions) Run() error
type ClusterWorkshopDeleteOptions ¶
type ClusterWorkshopDeleteOptions struct {
KubeconfigOptions
Name string
Alias string
Path string
Portal string
WorkshopFile string
WorkshopVersion string
DataValuesFlags yttcmd.DataValuesFlags
}
func (*ClusterWorkshopDeleteOptions) Run ¶
func (o *ClusterWorkshopDeleteOptions) Run() error
type ClusterWorkshopDeployOptions ¶
type ClusterWorkshopDeployOptions struct {
KubeconfigOptions
Name string
Alias string
Path string
Portal string
Capacity uint
Reserved uint
Initial uint
Expires string
Overtime string
Deadline string
Orphaned string
Overdue string
Refresh string
Repository string
Environ []string
Labels []string
WorkshopFile string
WorkshopVersion string
OpenBrowser bool
DataValuesFlags yttcmd.DataValuesFlags
}
func (*ClusterWorkshopDeployOptions) Run ¶
func (o *ClusterWorkshopDeployOptions) Run() error
type ClusterWorkshopRequestOptions ¶
type ClusterWorkshopRequestOptions struct {
KubeconfigOptions
Name string
Path string
Portal string
Params []string
ParamFiles []string
ParamsFiles []string
IndexUrl string
UserIdentity string
EnvironmentName string
ActivationTimeout int
NoBrowser bool
WorkshopFile string
WorkshopVersion string
DataValuesFlags yttcmd.DataValuesFlags
}
func (*ClusterWorkshopRequestOptions) Run ¶
func (o *ClusterWorkshopRequestOptions) Run() error
type ClusterWorkshopServeOptions ¶
type ClusterWorkshopServeOptions struct {
KubeconfigOptions
Name string
Path string
Portal string
ProxyProtocol string
ProxyHost string
ProxyPort int
LocalHost string
LocalPort int
HugoPort int
Token string
RefreshToken bool
Files bool
WorkshopFile string
WorkshopVersion string
PatchWorkshop bool
DataValuesFlags yttcmd.DataValuesFlags
}
func (*ClusterWorkshopServeOptions) Run ¶
func (o *ClusterWorkshopServeOptions) Run() error
type ClusterWorkshopUpdateOptions ¶
type ClusterWorkshopUpdateOptions struct {
KubeconfigOptions
Name string
Path string
Portal string
WorkshopFile string
WorkshopVersion string
DataValuesFlags yttcmd.DataValuesFlags
}
func (*ClusterWorkshopUpdateOptions) Run ¶
func (o *ClusterWorkshopUpdateOptions) Run() error
type ClusterWorkshopsListOptions ¶
type ClusterWorkshopsListOptions struct {
KubeconfigOptions
Portal string
}
func (*ClusterWorkshopsListOptions) Run ¶
func (o *ClusterWorkshopsListOptions) Run() error
type DockerExtensionBackendOptions ¶
type DockerExtensionBackendOptions struct {
Socket string
}
func (*DockerExtensionBackendOptions) Run ¶
func (o *DockerExtensionBackendOptions) Run(p *ProjectInfo) error
type DockerWorkshopDeleteOptions ¶
type DockerWorkshopDeployOptions ¶
type DockerWorkshopDeployOptions struct {
Path string
Host string
Port uint
LocalRepository string
DisableOpenBrowser bool
ImageRepository string
ImageVersion string
Cluster string
KubeConfig string
Assets string
WorkshopFile string
WorkshopImage string
WorkshopVersion string
PackageDelivery string
DataValuesFlags yttcmd.DataValuesFlags
}
type DockerWorkshopDetails ¶
type DockerWorkshopLogsOptions ¶
type DockerWorkshopOpenOptions ¶
type DockerWorkshopOpenOptions struct {
Name string
Path string
WorkshopFile string
WorkshopVersion string
DataValuesFlags yttcmd.DataValuesFlags
}
func (*DockerWorkshopOpenOptions) Run ¶
func (o *DockerWorkshopOpenOptions) Run() error
type DockerWorkshopsBackend ¶
type DockerWorkshopsBackend struct {
Manager DockerWorkshopsManager
ImageRepository string
ImageVersion string
}
func NewDockerWorkshopsBackend ¶
func NewDockerWorkshopsBackend(version string, imageRepository string) DockerWorkshopsBackend
func (*DockerWorkshopsBackend) DeleteWorkshop ¶
func (b *DockerWorkshopsBackend) DeleteWorkshop(w http.ResponseWriter, r *http.Request)
func (*DockerWorkshopsBackend) DeployWorkshop ¶
func (b *DockerWorkshopsBackend) DeployWorkshop(w http.ResponseWriter, r *http.Request)
func (*DockerWorkshopsBackend) ListWorkhops ¶
func (b *DockerWorkshopsBackend) ListWorkhops(w http.ResponseWriter, r *http.Request)
type DockerWorkshopsManager ¶
type DockerWorkshopsManager struct {
Statuses map[string]DockerWorkshopDetails
StatusesMutex sync.Mutex
}
func NewDockerWorkshopsManager ¶
func NewDockerWorkshopsManager() DockerWorkshopsManager
func (*DockerWorkshopsManager) ClearWorkshopStatus ¶
func (m *DockerWorkshopsManager) ClearWorkshopStatus(name string)
func (*DockerWorkshopsManager) DeleteWorkshop ¶
func (*DockerWorkshopsManager) DeployWorkshop ¶
func (m *DockerWorkshopsManager) DeployWorkshop(o *DockerWorkshopDeployOptions, stdout io.Writer, stderr io.Writer) (string, error)
func (*DockerWorkshopsManager) ListWorkhops ¶
func (m *DockerWorkshopsManager) ListWorkhops() ([]DockerWorkshopDetails, error)
func (*DockerWorkshopsManager) SetWorkshopStatus ¶
func (m *DockerWorkshopsManager) SetWorkshopStatus(name string, url string, source string, status string)
func (*DockerWorkshopsManager) WorkshopStatus ¶
func (m *DockerWorkshopsManager) WorkshopStatus(name string) (DockerWorkshopDetails, bool)
type FilesRenderOptions ¶
type FilesRenderOptions struct {
Repository string
WorkshopFile string
WorkshopVersion string
DataValuesFlags yttcmd.DataValuesFlags
OutputFile string
}
func (*FilesRenderOptions) Render ¶
func (o *FilesRenderOptions) Render(directory string, outputFile string) error
func (*FilesRenderOptions) Run ¶
func (o *FilesRenderOptions) Run(args []string) error
type KubeconfigOptions ¶
type LocalClusterDeleteOptions ¶
func (*LocalClusterDeleteOptions) Run ¶
func (o *LocalClusterDeleteOptions) Run() error
type LocalConfigExplainOptions ¶
type LocalConfigExplainOptions struct {
Kind string
}
type LocalConfigInitOptions ¶
type LocalConfigViewOptions ¶
type LocalConfigViewOptions struct {
Raw bool
}
type LocalMirrorDeleteOptions ¶
type LocalMirrorDeleteOptions struct {
MirrorName string
}
func (*LocalMirrorDeleteOptions) Run ¶
func (o *LocalMirrorDeleteOptions) Run() error
type LocalMirrorDeployOptions ¶
type LocalMirrorDeployOptions struct {
MirrorName string
MirrorURL string
Username string
Password string
Verbose bool
}
func (*LocalMirrorDeployOptions) Run ¶
func (o *LocalMirrorDeployOptions) Run() error
type LocalRegistryDeleteOptions ¶
type LocalRegistryDeleteOptions struct {
}
func (*LocalRegistryDeleteOptions) Run ¶
func (o *LocalRegistryDeleteOptions) Run() error
type LocalRegistryDeployOptions ¶
type LocalRegistryDeployOptions struct {
KubeconfigOptions
BindIP string
Verbose bool
}
func (*LocalRegistryDeployOptions) Run ¶
func (o *LocalRegistryDeployOptions) Run() error
type LocalRegistryPruneOptions ¶
type LocalRegistryPruneOptions struct {
}
func (*LocalRegistryPruneOptions) Run ¶
func (o *LocalRegistryPruneOptions) Run() error
type LocalResolverDeployOptions ¶
func (*LocalResolverDeployOptions) Run ¶
func (o *LocalResolverDeployOptions) Run() error
type LocalResolverUpdateOptions ¶
func (*LocalResolverUpdateOptions) Run ¶
func (o *LocalResolverUpdateOptions) Run() error
type LocalSecretsAddCaOptions ¶
func (*LocalSecretsAddCaOptions) Run ¶
func (o *LocalSecretsAddCaOptions) Run(w io.Writer, name string) error
Run caches CA material under name. With no files it generates a root CA; with a certificate and its key it registers them as the root CA; with a certificate alone it caches a CA certificate for trust only.
A root CA is cached as its CA trust Secret, name, holding the root certificate as ca.crt, and its CA root key pair, which holds the key and never leaves this machine. Deploys mint a CA for each ingress domain from the root. The cache holds at most one root.
type LocalSecretsAddDockerRegistryOptions ¶
type LocalSecretsAddDockerRegistryOptions struct {
Server string
Username string
Password string
Email string
}
func (*LocalSecretsAddDockerRegistryOptions) Run ¶
func (o *LocalSecretsAddDockerRegistryOptions) Run(name string) error
type LocalSecretsAddGenericOptions ¶
func (*LocalSecretsAddGenericOptions) Run ¶
func (o *LocalSecretsAddGenericOptions) Run(name string) error
type LocalSecretsAddTlsOptions ¶
func (*LocalSecretsAddTlsOptions) Run ¶
func (o *LocalSecretsAddTlsOptions) Run(name string) error
Run caches under name the wildcard TLS certificate in CertFile, with any intermediate certificates following it, and its private key in KeyFile. The certificate must not be a CA, the key must match it, and it must have at least one *.<domain> DNS SAN. The cached Secret records no domain: the domains it serves are its wildcard SANs.
type LocalSecretsImportOptions ¶
type LocalSecretsImportOptions struct {
File string
}
func (*LocalSecretsImportOptions) Run ¶
func (o *LocalSecretsImportOptions) Run() error
Run adds the Secrets of a YAML file to the local secrets cache, replacing cached Secrets of the same names. It checks every Secret before writing any, so a file it refuses leaves the cache unchanged.
The cache holds one root CA, so the file may hold at most one CA root key pair, and only when the cache has no root CA or has that same root.
type LocalSecretsListOptions ¶
type LocalSecretsListOptions struct{}
func (*LocalSecretsListOptions) Run ¶
func (o *LocalSecretsListOptions) Run(w io.Writer) error
Run prints the local secrets cache to w as a table with the columns NAME, TYPE, DOMAINS and EXPIRES. TYPE is the role the local certificate resolution step gives the Secret, through secrets.ClassifyCachedSecret, so the table shows each Secret as a deploy treats it. A file that cannot be read or decoded is listed as invalid too, and the rest of the table still prints. Failing to read the cache directory is an error.
type LocalSecretsRemoveOptions ¶
type LocalSecretsRemoveOptions struct{}
func (*LocalSecretsRemoveOptions) Run ¶
func (o *LocalSecretsRemoveOptions) Run(w io.Writer, name string) error
Run removes the secret name from the local secrets cache, printing a line for each cached secret it removes. Removing a root CA removes its CA trust Secret, its CA root key pair and every CA key pair minted from it.
type LocalSecretsSyncOptions ¶
type LocalSecretsSyncOptions struct {
KubeconfigOptions
}
func (*LocalSecretsSyncOptions) Run ¶
func (o *LocalSecretsSyncOptions) Run(w io.Writer) error
Run pushes the cached Secrets the local certificate resolution step selects into the cluster. CA root key pairs are never pushed; a CA key pair is pushed only when the local config selects it, and is minted first when it is missing or stale. When the certificates of the local config cannot be decided, it warns and pushes every Secret that holds no CA key.
type LocalSecretsViewOptions ¶
type LocalSecretsViewOptions struct{}
func (*LocalSecretsViewOptions) Run ¶
func (o *LocalSecretsViewOptions) Run(w io.Writer, name string) error
Run prints to w the details of the cached Secret name that do not fit the table of `educates local secrets list`, as labelled lines. Its role and domains are those the list shows, through the same classification, so the two always agree. It prints no key material: of a private key only whether the Secret holds one, of registry credentials only their registries, and of a generic Secret only the names of its keys. For an invalid entry it prints why it is invalid and the command that removes it, after, for a CA cached by a 4.0.0 alpha release, how to keep the CA. A name the cache does not hold is an error.
type LookupConfigOptions ¶
type LookupConfigOptions struct {
KubeconfigOptions
OutputPath string
}
func (*LookupConfigOptions) Run ¶
func (o *LookupConfigOptions) Run() error
type PlatformDeleteOptions ¶
type PlatformDeployOptions ¶
type PlatformDeployOptions struct {
Config string
LocalConfig bool
Kubeconfig string
Context string
Timeout time.Duration
Verbose bool
}
PlatformDeployOptions mirrors PlatformRenderOptions plus the kubectl connection flags consumed by the install path.
type PlatformRenderOptions ¶
type ProjectInfo ¶
type ProjectInfo struct {
Version string
ImageRepository string
// GitCommit is the short commit the binary was built from, with a
// "-dirty" suffix when the working tree had uncommitted changes. It
// is informational only (shown by `educates version`) — unlike
// Version, it never feeds image-tag resolution. Empty for a plain
// `go build` with no ldflags.
GitCommit string
// BuildDate is the commit date (YYYY-MM-DD) of GitCommit. Empty when
// GitCommit is.
BuildDate string
}
Project information.
func NewProjectInfo ¶
func NewProjectInfo(version string, imageRepository string, gitCommit string, buildDate string) ProjectInfo
Populate project information.
NOTE: This is expected to be provided with values corresponding to any defaults but where they could have been overridden at compile time as part of a release of the Educates CLI.
func (*ProjectInfo) NewAdminCmdGroup ¶
func (p *ProjectInfo) NewAdminCmdGroup() *cobra.Command
func (*ProjectInfo) NewAdminDiagnosticsAnalyzeCmd ¶
func (p *ProjectInfo) NewAdminDiagnosticsAnalyzeCmd() *cobra.Command
func (*ProjectInfo) NewAdminDiagnosticsCmdGroup ¶
func (p *ProjectInfo) NewAdminDiagnosticsCmdGroup() *cobra.Command
func (*ProjectInfo) NewAdminDiagnosticsCollectCmd ¶
func (p *ProjectInfo) NewAdminDiagnosticsCollectCmd() *cobra.Command
func (*ProjectInfo) NewAdminLookupCmdGroup ¶
func (p *ProjectInfo) NewAdminLookupCmdGroup() *cobra.Command
func (*ProjectInfo) NewAdminLookupKubeconfigCmd ¶
func (p *ProjectInfo) NewAdminLookupKubeconfigCmd() *cobra.Command
func (*ProjectInfo) NewAdminPlatformCmdGroup ¶
func (p *ProjectInfo) NewAdminPlatformCmdGroup() *cobra.Command
func (*ProjectInfo) NewAdminPlatformDeleteCmd ¶
func (p *ProjectInfo) NewAdminPlatformDeleteCmd() *cobra.Command
func (*ProjectInfo) NewAdminPlatformDeployCmd ¶
func (p *ProjectInfo) NewAdminPlatformDeployCmd() *cobra.Command
func (*ProjectInfo) NewAdminPlatformRenderCmd ¶
func (p *ProjectInfo) NewAdminPlatformRenderCmd() *cobra.Command
func (*ProjectInfo) NewClusterCmdGroup ¶
func (p *ProjectInfo) NewClusterCmdGroup() *cobra.Command
func (*ProjectInfo) NewClusterPortalCmdGroup ¶
func (p *ProjectInfo) NewClusterPortalCmdGroup() *cobra.Command
func (*ProjectInfo) NewClusterPortalCreateCmd ¶
func (p *ProjectInfo) NewClusterPortalCreateCmd() *cobra.Command
func (*ProjectInfo) NewClusterPortalDeleteCmd ¶
func (p *ProjectInfo) NewClusterPortalDeleteCmd() *cobra.Command
func (*ProjectInfo) NewClusterPortalExportCmd ¶
func (p *ProjectInfo) NewClusterPortalExportCmd() *cobra.Command
func (*ProjectInfo) NewClusterPortalListCmd ¶
func (p *ProjectInfo) NewClusterPortalListCmd() *cobra.Command
func (*ProjectInfo) NewClusterPortalOpenCmd ¶
func (p *ProjectInfo) NewClusterPortalOpenCmd() *cobra.Command
func (*ProjectInfo) NewClusterPortalPasswordCmd ¶
func (p *ProjectInfo) NewClusterPortalPasswordCmd() *cobra.Command
func (*ProjectInfo) NewClusterSessionCmdGroup ¶
func (p *ProjectInfo) NewClusterSessionCmdGroup() *cobra.Command
func (*ProjectInfo) NewClusterSessionExtendCmd ¶
func (p *ProjectInfo) NewClusterSessionExtendCmd() *cobra.Command
func (*ProjectInfo) NewClusterSessionListCmd ¶
func (p *ProjectInfo) NewClusterSessionListCmd() *cobra.Command
func (*ProjectInfo) NewClusterSessionStatusCmd ¶
func (p *ProjectInfo) NewClusterSessionStatusCmd() *cobra.Command
func (*ProjectInfo) NewClusterSessionTerminateCmd ¶
func (p *ProjectInfo) NewClusterSessionTerminateCmd() *cobra.Command
func (*ProjectInfo) NewClusterWorkshopCmdGroup ¶
func (p *ProjectInfo) NewClusterWorkshopCmdGroup() *cobra.Command
func (*ProjectInfo) NewClusterWorkshopDeleteCmd ¶
func (p *ProjectInfo) NewClusterWorkshopDeleteCmd() *cobra.Command
func (*ProjectInfo) NewClusterWorkshopDeployCmd ¶
func (p *ProjectInfo) NewClusterWorkshopDeployCmd() *cobra.Command
func (*ProjectInfo) NewClusterWorkshopListCmd ¶
func (p *ProjectInfo) NewClusterWorkshopListCmd() *cobra.Command
func (*ProjectInfo) NewClusterWorkshopRequestCmd ¶
func (p *ProjectInfo) NewClusterWorkshopRequestCmd() *cobra.Command
func (*ProjectInfo) NewClusterWorkshopServeCmd ¶
func (p *ProjectInfo) NewClusterWorkshopServeCmd() *cobra.Command
func (*ProjectInfo) NewClusterWorkshopUpdateCmd ¶
func (p *ProjectInfo) NewClusterWorkshopUpdateCmd() *cobra.Command
func (*ProjectInfo) NewDockerCmdGroup ¶
func (p *ProjectInfo) NewDockerCmdGroup() *cobra.Command
func (*ProjectInfo) NewDockerExtensionBackendCmd ¶
func (p *ProjectInfo) NewDockerExtensionBackendCmd() *cobra.Command
func (*ProjectInfo) NewDockerExtensionCmdGroup ¶
func (p *ProjectInfo) NewDockerExtensionCmdGroup() *cobra.Command
func (*ProjectInfo) NewDockerWorkshopCmdGroup ¶
func (p *ProjectInfo) NewDockerWorkshopCmdGroup() *cobra.Command
func (*ProjectInfo) NewDockerWorkshopDeleteCmd ¶
func (p *ProjectInfo) NewDockerWorkshopDeleteCmd() *cobra.Command
func (*ProjectInfo) NewDockerWorkshopDeployCmd ¶
func (p *ProjectInfo) NewDockerWorkshopDeployCmd() *cobra.Command
func (*ProjectInfo) NewDockerWorkshopListCmd ¶
func (p *ProjectInfo) NewDockerWorkshopListCmd() *cobra.Command
func (*ProjectInfo) NewDockerWorkshopLogsCmd ¶
func (p *ProjectInfo) NewDockerWorkshopLogsCmd() *cobra.Command
func (*ProjectInfo) NewDockerWorkshopOpenCmd ¶
func (p *ProjectInfo) NewDockerWorkshopOpenCmd() *cobra.Command
func (*ProjectInfo) NewEducatesCmdGroup ¶
func (p *ProjectInfo) NewEducatesCmdGroup() *cobra.Command
Create root Cobra command group for Educates CLI .
func (*ProjectInfo) NewLocalClusterCmdGroup ¶
func (p *ProjectInfo) NewLocalClusterCmdGroup() *cobra.Command
func (*ProjectInfo) NewLocalClusterCreateCmd ¶
func (p *ProjectInfo) NewLocalClusterCreateCmd() *cobra.Command
func (*ProjectInfo) NewLocalClusterDeleteCmd ¶
func (p *ProjectInfo) NewLocalClusterDeleteCmd() *cobra.Command
func (*ProjectInfo) NewLocalClusterStartCmd ¶
func (p *ProjectInfo) NewLocalClusterStartCmd() *cobra.Command
func (*ProjectInfo) NewLocalClusterStatusCmd ¶
func (p *ProjectInfo) NewLocalClusterStatusCmd() *cobra.Command
func (*ProjectInfo) NewLocalClusterStopCmd ¶
func (p *ProjectInfo) NewLocalClusterStopCmd() *cobra.Command
func (*ProjectInfo) NewLocalCmdGroup ¶
func (p *ProjectInfo) NewLocalCmdGroup() *cobra.Command
func (*ProjectInfo) NewLocalConfigCmdGroup ¶
func (p *ProjectInfo) NewLocalConfigCmdGroup() *cobra.Command
func (*ProjectInfo) NewLocalConfigEditCmd ¶
func (p *ProjectInfo) NewLocalConfigEditCmd() *cobra.Command
func (*ProjectInfo) NewLocalConfigExplainCmd ¶
func (p *ProjectInfo) NewLocalConfigExplainCmd() *cobra.Command
func (*ProjectInfo) NewLocalConfigGetCmd ¶
func (p *ProjectInfo) NewLocalConfigGetCmd() *cobra.Command
func (*ProjectInfo) NewLocalConfigInitCmd ¶
func (p *ProjectInfo) NewLocalConfigInitCmd() *cobra.Command
func (*ProjectInfo) NewLocalConfigSetCmd ¶
func (p *ProjectInfo) NewLocalConfigSetCmd() *cobra.Command
func (*ProjectInfo) NewLocalConfigViewCmd ¶
func (p *ProjectInfo) NewLocalConfigViewCmd() *cobra.Command
func (*ProjectInfo) NewLocalMirrorCmdGroup ¶
func (p *ProjectInfo) NewLocalMirrorCmdGroup() *cobra.Command
func (*ProjectInfo) NewLocalMirrorDeleteCmd ¶
func (p *ProjectInfo) NewLocalMirrorDeleteCmd() *cobra.Command
func (*ProjectInfo) NewLocalMirrorDeployCmd ¶
func (p *ProjectInfo) NewLocalMirrorDeployCmd() *cobra.Command
func (*ProjectInfo) NewLocalMirrorListCmd ¶
func (p *ProjectInfo) NewLocalMirrorListCmd() *cobra.Command
func (*ProjectInfo) NewLocalRegistryCmdGroup ¶
func (p *ProjectInfo) NewLocalRegistryCmdGroup() *cobra.Command
func (*ProjectInfo) NewLocalRegistryDeleteCmd ¶
func (p *ProjectInfo) NewLocalRegistryDeleteCmd() *cobra.Command
func (*ProjectInfo) NewLocalRegistryDeployCmd ¶
func (p *ProjectInfo) NewLocalRegistryDeployCmd() *cobra.Command
func (*ProjectInfo) NewLocalRegistryPruneCmd ¶
func (p *ProjectInfo) NewLocalRegistryPruneCmd() *cobra.Command
func (*ProjectInfo) NewLocalResolverCmdGroup ¶
func (p *ProjectInfo) NewLocalResolverCmdGroup() *cobra.Command
func (*ProjectInfo) NewLocalResolverDeleteCmd ¶
func (p *ProjectInfo) NewLocalResolverDeleteCmd() *cobra.Command
func (*ProjectInfo) NewLocalResolverDeployCmd ¶
func (p *ProjectInfo) NewLocalResolverDeployCmd() *cobra.Command
func (*ProjectInfo) NewLocalResolverUpdateCmd ¶
func (p *ProjectInfo) NewLocalResolverUpdateCmd() *cobra.Command
func (*ProjectInfo) NewLocalSecretsAddCaCmd ¶
func (p *ProjectInfo) NewLocalSecretsAddCaCmd() *cobra.Command
func (*ProjectInfo) NewLocalSecretsAddCmdGroup ¶
func (p *ProjectInfo) NewLocalSecretsAddCmdGroup() *cobra.Command
func (*ProjectInfo) NewLocalSecretsAddDockerRegistryCmd ¶
func (p *ProjectInfo) NewLocalSecretsAddDockerRegistryCmd() *cobra.Command
func (*ProjectInfo) NewLocalSecretsAddGenericCmd ¶
func (p *ProjectInfo) NewLocalSecretsAddGenericCmd() *cobra.Command
func (*ProjectInfo) NewLocalSecretsAddTlsCmd ¶
func (p *ProjectInfo) NewLocalSecretsAddTlsCmd() *cobra.Command
func (*ProjectInfo) NewLocalSecretsCmdGroup ¶
func (p *ProjectInfo) NewLocalSecretsCmdGroup() *cobra.Command
func (*ProjectInfo) NewLocalSecretsExportCmd ¶
func (p *ProjectInfo) NewLocalSecretsExportCmd() *cobra.Command
func (*ProjectInfo) NewLocalSecretsImportCmd ¶
func (p *ProjectInfo) NewLocalSecretsImportCmd() *cobra.Command
func (*ProjectInfo) NewLocalSecretsListCmd ¶
func (p *ProjectInfo) NewLocalSecretsListCmd() *cobra.Command
func (*ProjectInfo) NewLocalSecretsRemoveCmd ¶
func (p *ProjectInfo) NewLocalSecretsRemoveCmd() *cobra.Command
func (*ProjectInfo) NewLocalSecretsSyncCmd ¶
func (p *ProjectInfo) NewLocalSecretsSyncCmd() *cobra.Command
func (*ProjectInfo) NewLocalSecretsViewCmd ¶
func (p *ProjectInfo) NewLocalSecretsViewCmd() *cobra.Command
func (*ProjectInfo) NewPackageCmdGroup ¶
func (p *ProjectInfo) NewPackageCmdGroup() *cobra.Command
Create Cobra command group for commands related to extension packages.
func (*ProjectInfo) NewPackagePublishCmd ¶
func (p *ProjectInfo) NewPackagePublishCmd() *cobra.Command
func (*ProjectInfo) NewProjectCmdGroup ¶
func (p *ProjectInfo) NewProjectCmdGroup() *cobra.Command
Create Cobra command group for commands related to project.
func (*ProjectInfo) NewProjectDocsCmdGroup ¶
func (p *ProjectInfo) NewProjectDocsCmdGroup() *cobra.Command
Create Cobra command group for commands related to documentation.
NOTE: Using a command group here in case later on we want to support having the docs bundled in the binary, but still want to open hosted documentation, or have ability to download a newer version of development version of docs to local host for offline viewing.
func (*ProjectInfo) NewProjectDocsOpenCmd ¶
func (p *ProjectInfo) NewProjectDocsOpenCmd() *cobra.Command
Create Cobra command object for opening hosted docs in browser.
func (*ProjectInfo) NewProjectVersionCmd ¶
func (p *ProjectInfo) NewProjectVersionCmd() *cobra.Command
Create Cobra command object for displaying Educates version.
func (*ProjectInfo) NewTemplateCmdGroup ¶
func (p *ProjectInfo) NewTemplateCmdGroup() *cobra.Command
Create Cobra command group for commands related to workshops.
func (*ProjectInfo) NewTemplateListCmd ¶
func (p *ProjectInfo) NewTemplateListCmd() *cobra.Command
func (*ProjectInfo) NewTunnelCmdGroup ¶
func (p *ProjectInfo) NewTunnelCmdGroup() *cobra.Command
func (*ProjectInfo) NewTunnelConnectCmd ¶
func (p *ProjectInfo) NewTunnelConnectCmd() *cobra.Command
func (*ProjectInfo) NewWorkshopCmdGroup ¶
func (p *ProjectInfo) NewWorkshopCmdGroup() *cobra.Command
Create Cobra command group for commands related to workshops.
func (*ProjectInfo) NewWorkshopExportCmd ¶
func (p *ProjectInfo) NewWorkshopExportCmd() *cobra.Command
func (*ProjectInfo) NewWorkshopNewCmd ¶
func (p *ProjectInfo) NewWorkshopNewCmd() *cobra.Command
func (*ProjectInfo) NewWorkshopPublishCmd ¶
func (p *ProjectInfo) NewWorkshopPublishCmd() *cobra.Command
func (*ProjectInfo) NewWorkshopRenderCmd ¶
func (p *ProjectInfo) NewWorkshopRenderCmd() *cobra.Command
type ProjectVersionOptions ¶
type ProjectVersionOptions struct {
// contains filtered or unexported fields
}
type TunnelConnectOptions ¶
type TunnelConnectOptions struct {
Url string
}
Source Files
¶
- admin_cmd_group.go
- admin_diagnostics_analyze_cmd.go
- admin_diagnostics_cmd_group.go
- admin_diagnostics_collect_cmd.go
- admin_lookup_cmd_group.go
- admin_lookup_kubeconfig_cmd.go
- admin_platform_cmd_group.go
- admin_platform_delete_cmd.go
- admin_platform_deploy_cmd.go
- admin_platform_render_cmd.go
- args.go
- cluster_cmd_group.go
- cluster_portal_cmd_group.go
- cluster_portal_create_cmd.go
- cluster_portal_delete_cmd.go
- cluster_portal_export_cmd.go
- cluster_portal_list_cmd.go
- cluster_portal_open_cmd.go
- cluster_portal_password_cmd.go
- cluster_session_cmd_group.go
- cluster_session_extend_cmd.go
- cluster_session_list_cmd.go
- cluster_session_status_cmd.go
- cluster_session_terminate_cmd.go
- cluster_workshop_cmd_group.go
- cluster_workshop_delete_cmd.go
- cluster_workshop_deploy_cmd.go
- cluster_workshop_list_cmd.go
- cluster_workshop_request_cmd.go
- cluster_workshop_serve_cmd.go
- cluster_workshop_update_cmd.go
- deploy_pipeline.go
- docker_cmd_group.go
- docker_extension_backend_cmd.go
- docker_extension_cmd_group.go
- docker_image_pull.go
- docker_package_deliver.go
- docker_package_delivery.go
- docker_package_resolve.go
- docker_package_split.go
- docker_workshop_cmd_group.go
- docker_workshop_delete_cmd.go
- docker_workshop_deploy_cmd.go
- docker_workshop_list_cmd.go
- docker_workshop_logs.go
- docker_workshop_open_cmd.go
- educates_cmd_group.go
- local_cluster_cmd_group.go
- local_cluster_create_cmd.go
- local_cluster_create_preflight.go
- local_cluster_delete_cmd.go
- local_cluster_start_cmd.go
- local_cluster_status_cmd.go
- local_cluster_stop_cmd.go
- local_cmd_group.go
- local_config_cmd_group.go
- local_config_edit_cmd.go
- local_config_explain_cmd.go
- local_config_get_cmd.go
- local_config_init_cmd.go
- local_config_set_cmd.go
- local_config_view_cmd.go
- local_mirror_cmd_group.go
- local_mirror_delete_cmd.go
- local_mirror_deploy_cmd.go
- local_mirror_list_cmd.go
- local_registry_cmd_group.go
- local_registry_delete_cmd.go
- local_registry_deploy_cmd.go
- local_registry_prune_cmd.go
- local_resolver_cmd_group.go
- local_resolver_delete_cmd.go
- local_resolver_deploy_cmd.go
- local_resolver_update_cmd.go
- local_secrets_add_ca_cmd.go
- local_secrets_add_cmd.go
- local_secrets_add_generic_cmd.go
- local_secrets_add_registry_cmd.go
- local_secrets_add_tls_cmd.go
- local_secrets_cmd_group.go
- local_secrets_export_cmd.go
- local_secrets_import_cmd.go
- local_secrets_list_cmd.go
- local_secrets_remove_cmd.go
- local_secrets_sync_cmd.go
- local_secrets_view_cmd.go
- package_cmd_group.go
- package_docs.go
- package_publish_cmd.go
- progress_step.go
- project_cmd_group.go
- project_docs_cmd_group.go
- project_docs_open_cmd.go
- project_info.go
- project_version_cmd.go
- template_cmd_group.go
- template_list_cmd.go
- tunnel_cmd_group.go
- tunnel_connect_cmd.go
- types.go
- workshop_cmd_group.go
- workshop_export_cmd.go
- workshop_new_cmd.go
- workshop_packages_validate.go
- workshop_publish_cmd.go
- workshop_render_cmd.go