Documentation
¶
Index ¶
- func AddRegistrySecret(c *cli.Context)
- func AddTemplateRepo(c *cli.Context)
- func Commands()
- func ConnectionAddToList(c *cli.Context)
- func ConnectionGetByID(c *cli.Context)
- func ConnectionListAll(c *cli.Context)
- func ConnectionRemoveFromList(c *cli.Context)
- func ConnectionResetList(c *cli.Context)
- func ConnectionUpdate(c *cli.Context)
- func DeleteTemplateRepo(c *cli.Context)
- func DiagnosticsCollect(c *cli.Context)
- func DiagnosticsRemove(c *cli.Context)
- func DisableTemplateRepos(c *cli.Context)
- func DoRemoteInstall(c *cli.Context)
- func DoRemoteKeycloakRemove(c *cli.Context)
- func DoRemoteRemove(c *cli.Context)
- func EnableTemplateRepos(c *cli.Context)
- func GetAllConnectionVersions()
- func GetContainerVersions(connectionID string) (apiroutes.ContainerVersions, error)
- func GetRegistrySecrets(c *cli.Context)
- func GetSingleConnectionVersion(c *cli.Context)
- func GetVersions(c *cli.Context)
- func HandleConfigError(err *config.ConfigError)
- func HandleConnectionError(err *connections.ConError)
- func HandleDockerError(err *docker.DockerError)
- func HandleProjectError(err *project.ProjectError)
- func HandleRegistryError(err *RegistryError)
- func HandleRemInstError(err *remote.RemInstError)
- func HandleTemplateError(err *TemplateError)
- func InstallCommand(c *cli.Context)
- func ListTemplateRepos(c *cli.Context)
- func ListTemplateStyles(c *cli.Context)
- func ListTemplates(c *cli.Context)
- func LogLevels(c *cli.Context)
- func PrintTable(content []string)
- func ProjectBind(c *cli.Context)
- func ProjectCreate(c *cli.Context)
- func ProjectGet(c *cli.Context)
- func ProjectLinkCreate(c *cli.Context)
- func ProjectLinkDelete(c *cli.Context)
- func ProjectLinkList(c *cli.Context)
- func ProjectLinkUpdate(c *cli.Context)
- func ProjectList(c *cli.Context)
- func ProjectRemove(c *cli.Context)
- func ProjectRestart(c *cli.Context)
- func ProjectSync(c *cli.Context)
- func ProjectValidate(c *cli.Context)
- func RemoteListAll(c *cli.Context)
- func RemoveCommand(c *cli.Context, dockerComposeFile string)
- func RemoveRegistrySecret(c *cli.Context)
- func SecurityClientCreate(c *cli.Context)
- func SecurityClientGet(c *cli.Context)
- func SecurityClientGetSecret(c *cli.Context)
- func SecurityCreateRealm(c *cli.Context)
- func SecurityCreateRole(c *cli.Context)
- func SecurityKeyUpdate(c *cli.Context)
- func SecurityKeyValidate(c *cli.Context)
- func SecurityTokenGet(c *cli.Context)
- func SecurityTokenRefresh(c *cli.Context)
- func SecurityUserAddRole(c *cli.Context)
- func SecurityUserCreate(c *cli.Context)
- func SecurityUserGet(c *cli.Context)
- func SecurityUserSetPassword(c *cli.Context)
- func StartCommand(c *cli.Context, dockerComposeFile string, healthEndpoint string)
- func StatusCommand(c *cli.Context)
- func StatusCommandLocalConnection(c *cli.Context)
- func StatusCommandRemoteConnection(c *cli.Context)
- func StopAllCommand(c *cli.Context, dockerComposeFile string)
- func StopCommand(c *cli.Context, dockerComposeFile string)
- func UpgradeProjects(c *cli.Context)
- type RegistryError
- type TemplateError
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddRegistrySecret ¶
AddRegistrySecret : Set a docker registry secret.
func AddTemplateRepo ¶
AddTemplateRepo adds the provided template repo to PFE.
func ConnectionAddToList ¶
ConnectionAddToList : Add new connection to the connections config file and returns the ID of the added entry
func ConnectionGetByID ¶
ConnectionGetByID : Get connection by its id
func ConnectionListAll ¶
ConnectionListAll : Fetch all connections
func ConnectionRemoveFromList ¶
ConnectionRemoveFromList : Removes a connection from the connections config file and from associated secrets from the keychain
func ConnectionResetList ¶
ConnectionResetList : Reset to a single default local connection
func ConnectionUpdate ¶
ConnectionUpdate : Update an existing connection
func DeleteTemplateRepo ¶
DeleteTemplateRepo deletes the provided template repo from PFE.
func DiagnosticsCollect ¶ added in v0.14.0
DiagnosticsCollect to gather logs and project files to aid diagnosis of Codewind errors
func DiagnosticsRemove ¶ added in v0.14.0
DiagnosticsRemove to remove the diagnostics directory and all its contents
func DisableTemplateRepos ¶
DisableTemplateRepos disables templates repo of which Codewind is aware.
func DoRemoteInstall ¶
DoRemoteInstall : Deploy a remote PFE and support containers
func DoRemoteKeycloakRemove ¶
DoRemoteKeycloakRemove : Delete a remote Keycloak deployment
func DoRemoteRemove ¶
DoRemoteRemove : Delete a remote Codewind deployment
func EnableTemplateRepos ¶
EnableTemplateRepos enables templates repo of which Codewind is aware.
func GetAllConnectionVersions ¶
func GetAllConnectionVersions()
GetAllConnectionVersions : Prints the cwctl and container versions for all connections to console
func GetContainerVersions ¶ added in v0.14.0
func GetContainerVersions(connectionID string) (apiroutes.ContainerVersions, error)
GetContainerVersions : Gets the cwctl and container versions for a single connection
func GetRegistrySecrets ¶
GetRegistrySecrets : Retrieve docker registry secrets.
func GetSingleConnectionVersion ¶
GetSingleConnectionVersion : Prints the cwctl and container versions for a single connection to console
func GetVersions ¶
GetVersions : Gets versions of Codewind containers
func HandleConfigError ¶
func HandleConfigError(err *config.ConfigError)
HandleConfigError prints a Config error, in JSON format if the global flag is set and as a string if not
func HandleConnectionError ¶
func HandleConnectionError(err *connections.ConError)
HandleConnectionError prints a Connection error, in JSON format if the global flag is set and as a string if not
func HandleDockerError ¶
func HandleDockerError(err *docker.DockerError)
HandleDockerError prints a Docker error, in JSON format if the global flag is set and as a string if not
func HandleProjectError ¶
func HandleProjectError(err *project.ProjectError)
HandleProjectError prints a Project error, in JSON format if the global flag is set and as a string if not
func HandleRegistryError ¶
func HandleRegistryError(err *RegistryError)
HandleRegistryError prints a Registry error, in JSON format if the global flag is set, and as a string if not
func HandleRemInstError ¶
func HandleRemInstError(err *remote.RemInstError)
HandleRemInstError prints a RemInst error, in JSON format if the global flag is set and as a string if not
func HandleTemplateError ¶
func HandleTemplateError(err *TemplateError)
HandleTemplateError prints a Template error, in JSON format if the global flag is set, and as a string if not
func InstallCommand ¶
InstallCommand to pull images from dockerhub
func ListTemplateRepos ¶
ListTemplateRepos lists all template repos of which Codewind is aware.
func ListTemplateStyles ¶
ListTemplateStyles lists all template styles of which Codewind is aware.
func ListTemplates ¶
ListTemplates lists project templates of which Codewind is aware. Filter them by providing flags
func LogLevels ¶
LogLevels : Optionally set then display the log level information for a Codewind PFE container
func PrintTable ¶
func PrintTable(content []string)
PrintTable prints a formatted table into the terminal
func ProjectCreate ¶
ProjectCreate : Downloads template, create a new project then validate it
func ProjectGet ¶
ProjectGet : Prints information about a given project using its ID
func ProjectLinkCreate ¶ added in v0.14.0
ProjectLinkCreate : creates a new link
func ProjectLinkDelete ¶ added in v0.14.0
ProjectLinkDelete : deletes a link
func ProjectLinkList ¶ added in v0.14.0
ProjectLinkList : lists all the links for a project
func ProjectLinkUpdate ¶ added in v0.14.0
ProjectLinkUpdate : updates a link
func ProjectList ¶
ProjectList : Print the list of projects to the terminal
func ProjectValidate ¶
ProjectValidate : Detects the project type, and adds .cw-settings if it does not already exist
func RemoteListAll ¶
RemoteListAll prints information for all remote installations in the given namespace
func RemoveCommand ¶
RemoveCommand to remove all codewind and project images
func RemoveRegistrySecret ¶
RemoveRegistrySecret : Delete a docker registry secret.
func SecurityClientCreate ¶
SecurityClientCreate : Create a new client in Keycloak
func SecurityClientGet ¶
SecurityClientGet : Retrieve a client configuration from Keycloak
func SecurityClientGetSecret ¶
SecurityClientGetSecret : Retrieve a client secret from Keycloak
func SecurityCreateRealm ¶
SecurityCreateRealm : Create a realm in Keycloak
func SecurityCreateRole ¶
SecurityCreateRole : Create a role in an existing Keycloak realm
func SecurityKeyUpdate ¶
SecurityKeyUpdate : Creates or updates a key in the platforms keyring
func SecurityKeyValidate ¶
SecurityKeyValidate : Checks the key is available in the platform keyring
func SecurityTokenGet ¶
SecurityTokenGet : Authenticate and retrieve an access_token
func SecurityTokenRefresh ¶
SecurityTokenRefresh : Refresh the access token the cached refresh token
func SecurityUserAddRole ¶
SecurityUserAddRole : Add an existing role to the specified user
func SecurityUserCreate ¶
SecurityUserCreate : Create a user in a Keycloak realm
func SecurityUserGet ¶
SecurityUserGet : Retrieve the user detail from Keycloak
func SecurityUserSetPassword ¶
SecurityUserSetPassword : Set a users password in Keycloak
func StartCommand ¶
StartCommand : start the codewind containers
func StatusCommandLocalConnection ¶
StatusCommandLocalConnection : Output local connection details
func StatusCommandRemoteConnection ¶
StatusCommandRemoteConnection : Output remote connection details
func StopAllCommand ¶
StopAllCommand to stop codewind and project containers
func StopCommand ¶
StopCommand to stop only the codewind containers
Types ¶
type RegistryError ¶
RegistryError struct will format the error
func (*RegistryError) Error ¶
func (te *RegistryError) Error() string
RegistryError : Error formatted in JSON containing an errorOp and a description
type TemplateError ¶
TemplateError struct will format the error
func (*TemplateError) Error ¶
func (te *TemplateError) Error() string
TemplateError : Error formatted in JSON containing an errorOp and a description