Kosmos CLI commands helper
Kosmos CLI - kosmos.spcplatform.com
Options
--config string The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debug Prints the stack trace if an error occurs
-h, --help Help for kosmos
-o, --log-output string The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silent Run in silent mode and prevents any kosmos log output except panics & fatals
General commands
- kosmos api-resources - Display supported API resources
- kosmos api-versions - Display supported API versions
- kosmos completion - Generate shell completion scripts
- kosmos context - Configure contexts in kubeconfig
- kosmos create - Create Kosmos resources
- kosmos defaults - Manage default values for commands
- kosmos delete - Delete Kosmos resources
- kosmos disconnect - Disconnect from current Kosmos context and switch back to previous kube context
- kosmos generate - Generate configuration
- kosmos get - Get Kosmos resources
- kosmos info - Display information on CLI version, OS, and architecture
- kosmos install - Install Kosmos resources
- kosmos join - Join a cluster to Kosmos
- kosmos list - List Kosmos resources
- kosmos login - Log in to Kosmos
- kosmos logout - Log out of Kosmos
- kosmos reset - Reset configuration
- kosmos set - Configure Kosmos environment settings
- kosmos share - Share cluster resources
- kosmos sleep - Put space or virtual cluster to sleep
- kosmos token - Print access token to a Kosmos instance
- kosmos uninstall - Uninstall Kosmos resources
- kosmos update - Update Kosmos resources
- kosmos use - Activate a kube context for the given cluster / space / vcluster / management
- kosmos vars - Print predefined variables
- kosmos wakeup - Wake up a space or virtual cluster
Commands with description
You can generate a table of all the available commands using kosmos generate table
| COMMAND | DESCRIPTION |
|---|---|
| kosmos api-resources [flags] | Display supported API resources |
| kosmos api-versions [flags] | Display supported API versions |
| kosmos completion [bash | zsh |
| kosmos context | Configure contexts in kubeconfig |
| kosmos context delete [flags] | Delete a context entry from kubeconfig |
| kosmos context get [flags] | Get a context entry from kubeconfig |
| kosmos context list [flags] | List all context entries in kubeconfig |
| kosmos context set [flags] | Set a context entry in kubeconfig |
| kosmos context use [flags] | Set current context in kubeconfig |
| kosmos create | Create Kosmos resources |
| kosmos create aks [flags] | Create an AKS cluster |
| kosmos create aksoidcconnect [flags] | Create an AKS OIDC connect |
| kosmos create app [flags] | Create an app |
| kosmos create clusterroletemplate [flags] | Create a cluster role template |
| kosmos create devspaceclusteraccess [flags] | Create a devspace cluster access |
| kosmos create devspacerole [flags] | Create a devspace role |
| kosmos create devspacesecret [flags] | Create a devspace secret |
| kosmos create devspaceteam [flags] | Create a devspace team |
| kosmos create eks [flags] | Create an EKS cluster |
| kosmos create eksoidcconnect [flags] | Create an EKS OIDC connect |
| kosmos create fleetclusteraccess [flags] | Create a fleet cluster access |
| kosmos create fleetclusterroletemplate [flags] | Create a fleet cluster role template |
| kosmos create fleetrole [flags] | Create a fleet role |
| kosmos create fleetsecret [flags] | Create a fleet secret |
| kosmos create fleetspacetemplate [flags] | Create a fleet space template |
| kosmos create fleetteam [flags] | Create a fleet team |
| kosmos create genericcluster [flags] | Create a generic cluster |
| kosmos create gke [flags] | Create a GKE cluster |
| kosmos create gkeoidcconnect [flags] | Create a GKE OIDC connect |
| kosmos create mks [flags] | Create an MKS cluster |
| kosmos create mksoidcconnect [flags] | Create an MKS OIDC connect |
| kosmos create vaultconfiguration [flags] | Create a vault configuration |
| kosmos create vcluster [flags] | Create a virtual cluster |
| kosmos create vclustertemplate [flags] | Create a virtual cluster template |
| kosmos defaults | Manage default values for commands |
| kosmos defaults get [flags] | Get a default value configured for commands |
| kosmos defaults set [flags] | Set default value for commands |
| kosmos defaults view [flags] | View all defaults values for commands |
| kosmos delete | Delete Kosmos resources |
| kosmos delete aks [flags] | Delete an AKS cluster |
| kosmos delete aksoidcconnect [flags] | Delete an AKS OIDC connect |
| kosmos delete app [flags] | Delete an app |
| kosmos delete clusterroletemplate [flags] | Delete a cluster role template |
| kosmos delete devspaceclusteraccess [flags] | Delete a devspace cluster access |
| kosmos delete devspacerole [flags] | Delete a devspace role |
| kosmos delete devspacesecret [flags] | Delete a devspace secret |
| kosmos delete devspaceteam [flags] | Delete a devspace team |
| kosmos delete eks [flags] | Delete an EKS cluster |
| kosmos delete eksoidcconnect [flags] | Delete an EKS OIDC connect |
| kosmos delete fleetclusteraccess [flags] | Delete a fleet cluster access |
| kosmos delete fleetclusterroletemplate [flags] | Delete a fleet cluster role template |
| kosmos delete fleetrole [flags] | Delete a fleet role |
| kosmos delete fleetsecret [flags] | Delete a fleet secret |
| kosmos delete fleetspacetemplate [flags] | Delete a fleet space template |
| kosmos delete fleetteam [flags] | Delete a fleet team |
| kosmos delete genericcluster [flags] | Delete a generic cluster |
| kosmos delete gke [flags] | Delete a GKE cluster |
| kosmos delete gkeoidcconnect [flags] | Delete a GKE OIDC connect |
| kosmos delete mks [flags] | Delete an MKS cluster |
| kosmos delete mksoidcconnect [flags] | Delete an MKS OIDC connect |
| kosmos delete vaultconfiguration [flags] | Delete a vault configuration |
| kosmos delete vcluster [flags] | Delete a virtual cluster |
| kosmos delete vclustertemplate [flags] | Delete a virtual cluster template |
| kosmos disconnect [flags] | Disconnect from current Kosmos context and switch back to previous kube context |
| kosmos generate | Generate configuration |
| kosmos generate admin-kube-config [flags] | Generate a new kubeconfig to connect a cluster to Kosmos |
| kosmos generate doc [flags] | Generate documentation for CLI |
| kosmos generate table [flags] | Generate table of available commands |
| kosmos get | Get Kosmos resources |
| kosmos get aks [flags] | Return information about a specified AKS cluster |
| kosmos get aksoidcconnect [flags] | Return information about a specified AKS OIDC connect |
| kosmos get app [flags] | Return information about a specified app |
| kosmos get applicationrole [flags] | Return information about a specified application role |
| kosmos get clusteraccesskey [flags] | Return information about a specified network peer cluster access key |
| kosmos get clusterroletemplate [flags] | Return information about a specified cluster role template |
| kosmos get currentuser [flags] | Return information about current Kosmos user |
| kosmos get devspace [flags] | Return information about a specified devspace |
| kosmos get devspaceallowedcluster [flags] | Return information about a specified devspace allowed cluster |
| kosmos get devspaceclusteraccess [flags] | Return information about a specified devspace cluster access |
| kosmos get devspacerole [flags] | Return information about a specified devspace role |
| kosmos get devspacesecret [flags] | Return information about a specified devspace secret |
| kosmos get devspaceteam [flags] | Return information about a specified devspace team |
| kosmos get eks [flags] | Return information about a specified EKS cluster |
| kosmos get eksoidcconnect [flags] | Return information about a specified EKS OIDC connect |
| kosmos get fleet [flags] | Return information about a specified fleet |
| kosmos get fleetclusteraccess [flags] | Return information about a specified fleet cluster access |
| kosmos get fleetclusterroletemplate [flags] | Return information about a specified fleet cluster role template |
| kosmos get fleetrole [flags] | Return information about a specified fleet role |
| kosmos get fleetsecret [flags] | Return information about a specified fleet secret |
| kosmos get fleetspacetemplate [flags] | Return information about a specified fleet space template |
| kosmos get fleetteam [flags] | Return information about a specified fleet team |
| kosmos get genericcluster [flags] | Return information about a specified generic cluster |
| kosmos get gke [flags] | Return information about a specified GKE cluster |
| kosmos get gkeoidcconnect [flags] | Return information about a specified GKE OIDC connect |
| kosmos get mks [flags] | Return information about a specified MKS cluster |
| kosmos get mksoidcconnect [flags] | Return information about a specified MKS OIDC connect |
| kosmos get secret [flags] | Return information about key and value of a project / shared secret |
| kosmos get team [flags] | Return information about a specified team |
| kosmos get vaultconfiguration [flags] | Return information about a specified vault configuration |
| kosmos get vcluster [flags] | Return information about a specified virtual cluster |
| kosmos get vclustertemplate [flags] | Return information about a specified virtual cluster template |
| kosmos info [flags] | Display information on CLI version, OS, and architecture |
| kosmos install | Install Kosmos resources |
| kosmos install app [flags] | Install an app from an app template |
| kosmos join | Join a cluster to Kosmos |
| kosmos join cluster [flags] | Join a cluster to Kosmos |
| kosmos list | List Kosmos resources |
| kosmos list accesskeys [flags] | List access keys you have access to |
| kosmos list aks [flags] | List AKS clusters you have access to |
| kosmos list aksoidcconnects [flags] | List AKS OIDC connects |
| kosmos list applicationroles [flags] | List appplication roles associated with target |
| kosmos list apps [flags] | List apps |
| kosmos list clusterroletemplates [flags] | List cluster role templates |
| kosmos list clusters [flags] | List clusters you have access to |
| kosmos list devspaceallowedclusters [flags] | List devspace allowed clusters you have access to |
| kosmos list devspaceclusteraccesses [flags] | List devspace cluster accesses you have accesses to |
| kosmos list devspaceroles [flags] | List devspace roles you have access to |
| kosmos list devspaces [flags] | List devspaces you are a member of |
| kosmos list devspacesecrets [flags] | List devspace secrets you have access to |
| kosmos list devspaceteams [flags] | List devspace teams you have access to |
| kosmos list eks [flags] | List EKS clusters you have access to |
| kosmos list eksoidcconnects [flags] | List EKS OIDC connects |
| kosmos list fleetclusteraccesses [flags] | List fleet cluster accesses |
| kosmos list fleetclusterroletemplates [flags] | List fleet cluster role templates |
| kosmos list fleetroles [flags] | List fleet roles you have access to |
| kosmos list fleets [flags] | List fleets you have access to |
| kosmos list fleetsecrets [flags] | List fleet secrets you have access to |
| kosmos list fleetspacetemplates [flags] | List fleet space templates |
| kosmos list fleetteams [flags] | List fleet teams you have access to |
| kosmos list genericclusters [flags] | List generic clusters you have access to |
| kosmos list gke [flags] | List GKE clusters you have access to |
| kosmos list gkeoidcconnects [flags] | List GKE OIDC connects |
| kosmos list hostclusters [flags] | List host clusters |
| kosmos list mks [flags] | List MKS clusters you have access to |
| kosmos list mksoidcconnects [flags] | List MKS OIDC connects |
| kosmos list quotas [flags] | List quotas for a particular devspace |
| kosmos list secrets [flags] | List shared secrets you have access to |
| kosmos list teams [flags] | List teams you are member of |
| kosmos list vaultconfigurations [flags] | List vault configurations you have access to |
| kosmos list vclusters [flags] | List virtual clusters you have access to |
| kosmos list vclustertemplates [flags] | List virtual cluster templates |
| kosmos login [KOSMOS_HOST] [flags] | Log in to Kosmos |
| kosmos logout [flags] | Log out of Kosmos |
| kosmos reset | Reset configuration |
| kosmos reset password [flags] | Reset password of a user |
| kosmos set | Configure Kosmos environment settings |
| kosmos set secret [flags] | Set key and value of a project / shared secret |
| kosmos share | Share cluster resources |
| kosmos share vcluster [flags] | Share a virtual cluster with another Kosmos user or team |
| kosmos sleep | Put space or virtual cluster to sleep |
| kosmos sleep vcluster [flags] | Put a virtual cluster to sleep |
| kosmos token [flags] | Print access token to a Kosmos instance |
| kosmos uninstall | Uninstall Kosmos resources |
| kosmos uninstall app [flags] | Uninstall an app |
| kosmos update | Update Kosmos resources |
| kosmos update aks [flags] | Update an existing AKS cluster |
| kosmos update aksoidcconnect [flags] | Update an existing AKS OIDC connect |
| kosmos update app [flags] | Update an existing app |
| kosmos update applicationrole [flags] | Update an existing application role |
| kosmos update clusterroletemplate [flags] | Update an existing cluster role template |
| kosmos update devspace [flags] | Update an existing devspace |
| kosmos update devspaceclusteraccess [flags] | Update an existing devspace cluster access |
| kosmos update devspacerole [flags] | Update an existing devspace role |
| kosmos update devspacesecret [flags] | Update an existing devspace secret |
| kosmos update devspaceteam [flags] | Update an existing devspace team |
| kosmos update eks [flags] | Update an existing EKS cluster |
| kosmos update eksoidcconnect [flags] | Update an existing EKS OIDC connect |
| kosmos update fleet [flags] | Update an existing fleet |
| kosmos update fleetclusteraccess [flags] | Update an existing fleet cluster access |
| kosmos update fleetclusterroletemplate [flags] | Update an existing fleet cluster role template |
| kosmos update fleetrole [flags] | Update an existing fleet role |
| kosmos update fleetsecret [flags] | Update an existing fleet secret |
| kosmos update fleetspacetemplate [flags] | Update an existing fleet space template |
| kosmos update fleetteam [flags] | Update an existing fleet team |
| kosmos update genericcluster [flags] | Update an existing generic cluster |
| kosmos update gke [flags] | Update an existing GKE cluster |
| kosmos update gkeoidcconnect [flags] | Update an existing GKE OIDC connect |
| kosmos update mks [flags] | Update an existing MKS cluster |
| kosmos update mksoidcconnect [flags] | Update an existing MKS OIDC connect |
| kosmos update vaultconfiguration [flags] | Update an existing vault configuration |
| kosmos update vcluster [flags] | Update an existing virtual cluster |
| kosmos update vclustertemplate [flags] | Update an existing virtual cluster template |
| kosmos use | Activate a kube context for the given cluster / space / vcluster / management |
| kosmos use cluster [flags] | Create a kube context for a specified cluster |
| kosmos use hostcluster [flags] | Create a kube context for a specified host cluster |
| kosmos use management [flags] | Create a kube context to the Kosmos Management API |
| kosmos use vcluster [flags] | Create a kube context for a specified virtual cluster |
| kosmos vars | Print predefined variables |
| kosmos vars cluster [flags] | Print the current cluster’s predefined variables |
| kosmos vars username [flags] | Print the current Kosmos username |
| kosmos wakeup | Wake up a space or virtual cluster |
| kosmos wakeup vcluster [flags] | Wake up a virtual cluster |
kosmos api-resources
Display supported API resources
Synopsis
The kosmos api-resources command is used to display supported API resources.
kosmos api-resources [flags]
Examples
kosmos api-resources
Options
| Flag | Description |
|---|---|
-h, --help | Help for api-resources |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos api-versions
Display supported API versions
Synopsis
The kosmos api-versions command is used to display supported API versions.
kosmos api-versions [flags]
Examples
kosmos api-versions
Options
| Flag | Description |
|---|---|
-h, --help | Help for api-versions |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos completion
Generate shell completion scripts
Synopsis
The kosmos completion command is used to generate shell completion scripts for supported shells.
To load completions:
Bash:
source <(kosmos completion bash)
To load completions for each session (execute once):
Linux:
kosmos completion bash > /etc/bash_completion.d/kosmosMacOS:
kosmos completion bash > /usr/local/etc/bash_completion.d/kosmos
Zsh:
If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once:
echo "autoload -U compinit; compinit" >> ~/.zshrc
To load completions for each session, execute once:
kosmos completion zsh > "${fpath[1]}/_kosmos"
Note: You will need to start a new shell for this setup to take effect.
Fish:
kosmos completion fish | source
To load completions for each session, execute once:
kosmos completion fish > ~/.config/fish/completions/kosmos.fish
PowerShell
To generate PowerShell completions:
kosmos completion powershell
Usage
kosmos completion [bash|zsh|fish|powershell]
Options
| Flag | Description |
|---|---|
-h, --help | Help for completion |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos context
Configure contexts in kubeconfig
Synopsis
The kosmos context command is used to configure or manage context entries in kubeconfig file.
Options
| Flag | Description |
|---|---|
-h, --help | Help for context |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos context delete
Delete a context entry from kubeconfig
Synopsis
The kosmos context delete command is used to remove a specified context entry from the kubeconfig file.
kosmos context delete [flags]
Examples
kosmos context delete --name <context-name>
Options
| Flag | Description |
|---|---|
-h, --help | Help for delete |
-n, --name string | Name of the context in kubeconfig |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos context get
Get a context entry from kubeconfig
Synopsis
The kosmos context get command is used to retrieve a specific context entry from kubeconfig file.
kosmos context get [flags]
Examples
kosmos context get --name <context-name>
Options
| Flag | Description |
|---|---|
-h, --help | Help for get |
-n, --name string | Name of the context |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos context list
List all context entries in kubeconfig
Synopsis
The kosmos context list command is used to display all context entries in kubeconfig file.
kosmos context list [flags]
Examples
kosmos context list
Options
| Flag | Description |
|---|---|
-h, --help | Help for list |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos context set
Set a context entry in kubeconfig
Synopsis
The kosmos context set command is used to configure or update a context entry in kubeconfig file.
kosmos context set [flags]
Examples
kosmos context set --virtualcluster <virtual-cluster-name> --devspace <devspace-name>
Options
| Flag | Description |
|---|---|
--devspace string | DevSpace of virtual cluster |
-h, --help | Help for set |
--virtualcluster string | Name of virtual cluster |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos context use
Set current context in kubeconfig
Synopsis
The kosmos context use command is used to update current context in the kubeconfig file to the specified context.
kosmos context use [flags]
Examples
kosmos context use --name <context-name>
Options
| Flag | Description |
|---|---|
-h, --help | Help for use |
--name string | Name of the context entry in kubeconfig |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos create
Create Kosmos resources
Synopsis
The kosmos create command is used to create various resources in Kosmos.
Options
| Flag | Description |
|---|---|
-h, --help | Help for create |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos create aks
Create an AKS cluster
Synopsis
The kosmos create aks command is used to create a new Azure Kubernetes Service (AKS) cluster with specified configurations.
kosmos create aks [flags]
Examples
kosmos create aks --name <aks-cluster-name> --file <path-to-yaml-file>
kosmos create aks --name <aks-cluster-name> --file <path-to-yaml-file> --fleet <fleet-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
aksConfig:
authBaseUrl: ""
authorizedIpRanges:
- ""
baseUrl: ""
clientID: ""
clusterName: ""
deleteOnDetachment: false
dnsPrefix: ""
dnsServiceIp: ""
httpApplicationRouting: false
imported: false
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
kubernetesVersion: ""
linuxAdminUsername: ""
loadBalancerSku: ""
logAnalyticsWorkspaceGroup: ""
logAnalyticsWorkspaceName: ""
managedIdentity: false
monitoring: false
networkPlugin: ""
networkPolicy: ""
nodePools:
- availabilityZones:
- ""
count: 0
enableAutoScaling: false
maxCount: 0
maxPods: 0
maxSurge: ""
minCount: 0
mode: ""
name: ""
nodeLabels: null
nodeTaints:
- ""
orchestratorVersion: ""
osDiskSizeGB: 0
osDiskType: ""
osType: ""
vmSize: ""
vnetSubnetID: ""
nodeResourceGroup: ""
outboundType: ""
podCidr: ""
privateCluster: false
privateDnsZone: ""
resourceGroup: ""
resourceLocation: ""
serviceCidr: ""
sshPublicKey: ""
subnet: ""
subscriptionID: ""
tags: null
tenantID: ""
userAssignedIdentity: ""
virtualNetwork: ""
virtualNetworkResourceGroup: ""
authorization:
adminTeams:
- ""
adminUsers:
- ""
binaryAuthorization:
evaluationMode: ""
description: ""
displayName: ""
loggingConfig:
componentConfig:
enableComponents:
- ""
monitoringConfig:
managedPrometheusConfig:
enabled: false
managedThanosConfig:
enabled: false
name: ""
oidcConfig:
issuerUri: ""
jwks: ""
owner: ""
Options
| Flag | Description |
|---|---|
--config-deleteondetachment | (Default true) |
--description string | Description of AKS cluster |
--displayname string | Display name of AKS cluster |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Create AKS cluster from a YAML file |
--fleet string | Fleet of AKS cluster |
-h, --help | Help for aks |
--name string | Name of AKS cluster |
--skeleton | Outputs skeleton YAML that can be used with the –file flag |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos create aksoidcconnect
Create an AKS OIDC connect
Synopsis
The kosmos create aksoidcconnect command is used to create a new AKS OIDC connect with specified configurations.
kosmos create aksoidcconnect [flags]
Examples
kosmos create aksoidcconnect --name <aksoidcconnect-name> --file <path-to-yaml-file>
kosmos create aksoidcconnect --name <aksoidcconnect-name> --file <path-to-yaml-file> --fleet <fleet-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
clientID: ""
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
name: ""
subscriptionID: ""
tenantID: ""
Options
| Flag | Description |
|---|---|
--client-id string | Client ID for AKS OIDC Connect |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Create AKS OIDC connect from a YAML file |
--fleet string | Fleet of AKS OIDC connect |
-h, --help | Help for aksoidcconnect |
--jwt-claims string | JWT Claims in JSON format e.g. ‘{"aud": " ", "iss": " ", "sub": " "}’ |
--name string | Name of AKS OIDC connect |
--skeleton | Outputs skeleton YAML that can be used with the –file flag |
--subscription-id string | Subscription id for AKS OIDC connect |
--tenant-id string | Tenant ID for AKS OIDC connect |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos create app
Create an app
Synopsis
The kosmos create app command is used to create a new app with specified configurations.
kosmos create app [flags]
Examples
kosmos create app --file <path-to-yaml-file>
kosmos create app --name <app-name> --description <description> --displayname <display-name> --clusters <cluster-name>[,<cluster-name>...]
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
applicationRoles:
- description: ""
displayName: ""
role: ""
verbs:
- ""
clusters:
- ""
config:
annotations: null
bash:
clusterRole: ""
image: ""
podSecurityContext:
appArmorProfile:
localhostProfile: ""
type: ""
fsGroup: 0
fsGroupChangePolicy: ""
runAsGroup: 0
runAsNonRoot: false
runAsUser: 0
seLinuxChangePolicy: ""
seLinuxOptions:
level: ""
role: ""
type: ""
user: ""
seccompProfile:
localhostProfile: ""
type: ""
supplementalGroups:
- 0
supplementalGroupsPolicy: ""
sysctls:
- name: ""
value: ""
windowsOptions:
gmsaCredentialSpec: ""
gmsaCredentialSpecName: ""
hostProcess: false
runAsUserName: ""
script: ""
securityContext:
allowPrivilegeEscalation: false
appArmorProfile:
localhostProfile: ""
type: ""
capabilities:
add:
- ""
drop:
- ""
privileged: false
procMount: ""
readOnlyRootFilesystem: false
runAsGroup: 0
runAsNonRoot: false
runAsUser: 0
seLinuxOptions:
level: ""
role: ""
type: ""
user: ""
seccompProfile:
localhostProfile: ""
type: ""
windowsOptions:
gmsaCredentialSpec: ""
gmsaCredentialSpecName: ""
hostProcess: false
runAsUserName: ""
chart:
insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
repoURL: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
version: ""
manifests: ""
parameters: ""
values: ""
defaultNamespace: ""
description: ""
displayName: ""
helm:
insecure: false
name: ""
password: ""
repoUrl: ""
username: ""
values: ""
version: ""
icon: ""
manifests: ""
owner:
team: ""
user: ""
parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
readme: ""
recommendedApp:
- ""
streamContainer:
container: ""
selector:
matchExpressions:
- key: ""
operator: ""
values:
- ""
matchLabels: null
timeout: ""
versions:
- config:
annotations: null
bash:
clusterRole: ""
image: ""
podSecurityContext:
appArmorProfile:
localhostProfile: ""
type: ""
fsGroup: 0
fsGroupChangePolicy: ""
runAsGroup: 0
runAsNonRoot: false
runAsUser: 0
seLinuxChangePolicy: ""
seLinuxOptions:
level: ""
role: ""
type: ""
user: ""
seccompProfile:
localhostProfile: ""
type: ""
supplementalGroups:
- 0
supplementalGroupsPolicy: ""
sysctls:
- name: ""
value: ""
windowsOptions:
gmsaCredentialSpec: ""
gmsaCredentialSpecName: ""
hostProcess: false
runAsUserName: ""
script: ""
securityContext:
allowPrivilegeEscalation: false
appArmorProfile:
localhostProfile: ""
type: ""
capabilities:
add:
- ""
drop:
- ""
privileged: false
procMount: ""
readOnlyRootFilesystem: false
runAsGroup: 0
runAsNonRoot: false
runAsUser: 0
seLinuxOptions:
level: ""
role: ""
type: ""
user: ""
seccompProfile:
localhostProfile: ""
type: ""
windowsOptions:
gmsaCredentialSpec: ""
gmsaCredentialSpecName: ""
hostProcess: false
runAsUserName: ""
chart:
insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
repoURL: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
version: ""
manifests: ""
parameters: ""
values: ""
defaultNamespace: ""
icon: ""
parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
readme: ""
streamContainer:
container: ""
selector:
matchExpressions:
- key: ""
operator: ""
values:
- ""
matchLabels: null
timeout: ""
version: ""
wait: false
wait: false
Options
| Flag | Description |
|---|---|
--clusters strings | Clusters the app can be installed in (comma separated) |
--description string | Description of app |
--displayname string | Display name of app |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Create app from a YAML file |
-h, --help | Help for app |
--name string | Name of app |
--owner-team string | Owner team |
--owner-user string | Owner user |
--skeleton | Outputs skeleton YAML that can be used with the –file flag |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos create clusterroletemplate
Create a cluster role template
Synopsis
The kosmos create clusterroletemplate command is used to create a new cluster role template with specified configurations.
kosmos create clusterroletemplate [flags]
Examples
kosmos create clusterroletemplate --file <path-to-yaml-file>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusterRoleTemplate:
aggregationRule:
clusterRoleSelectors:
- matchExpressions:
- key: ""
operator: ""
values:
- ""
matchLabels: null
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
rules:
- apiGroups:
- ""
nonResourceURLs:
- ""
resourceNames:
- ""
resources:
- ""
verbs:
- ""
clusters:
- ""
description: ""
displayName: ""
localClusterRoleTemplate:
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
clusterRoleTemplate:
aggregationRule:
clusterRoleSelectors:
- matchExpressions:
- key: ""
operator: ""
values:
- ""
matchLabels: null
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
rules:
- apiGroups:
- ""
nonResourceURLs:
- ""
resourceNames:
- ""
resources:
- ""
verbs:
- ""
description: ""
displayName: ""
management: false
owner:
team: ""
user: ""
Options
| Flag | Description |
|---|---|
--access string | Access rights for users and teams in JSON format e.g. ‘[{"name": " ", "verbs": [" "," "], "subresources": [" "," "], "users": [" "," "], "teams": [" "," "]}]’ |
--clusters strings | Clusters the template should be applied on (comma separated) |
--description string | Description of cluster role template |
--displayname string | Display name of cluster role template |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Create cluster role template from a YAML file |
-h, --help | Help for clusterroletemplate |
--name string | Name of cluster role template |
--owner-team string | Owner team |
--owner-user string | Owner user |
--skeleton | Outputs skeleton YAML that can be used with the –file flag |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos create devspaceclusteraccess
Create a devspace cluster access
Synopsis
The kosmos create devspaceclusteraccess command is used to create a new devspace cluster access with specified configurations.
kosmos create devspaceclusteraccess [flags]
Examples
kosmos create devspaceclusteraccess --name <devspaceclusteraccess-name> --file <path-to-yaml-file>
kosmos create devspaceclusteraccess --name <devspaceclusteraccess-name> --file <path-to-yaml-file> --devspace <devspace-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusters:
- ""
description: ""
displayName: ""
localClusterAccessTemplate:
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
clusterRoles:
- name: ""
description: ""
displayName: ""
priority: 0
teams:
- ""
users:
- team: ""
user: ""
owner:
team: ""
user: ""
Options
| Flag | Description |
|---|---|
--access string | Access rights for users and teams in JSON format e.g. ‘[{"name": " ", "verbs": [" "," "], "subresources": [" "," "], "users": [" "," "], "teams": [" "," "]}]’ |
--clusters strings | Clusters the template should be applied on (comma separated) |
--description string | Description of devspace cluster access |
--devspace string | Devspace of devspace cluster access |
--displayname string | Display name of devspace cluster access |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Create devspace cluster access from a YAML file |
-h, --help | Help for devspaceclusteraccess |
--name string | Name of devspace cluster access |
--owner-team string | Owner team |
--owner-user string | Owner user |
--skeleton | Outputs skeleton YAML that can be used with the –file flag |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos create devspacerole
Create a devspace role
Synopsis
The kosmos create devspacerole command is used to create a new devspace role with specified configurations.
kosmos create devspacerole [flags]
Examples
kosmos create devspacerole --file <path-to-yaml-file>
kosmos create devspacerole --name <devspacerole-name> --devspace <devspace-name> --rules '[{"resources": ["<resource>"[,...]],"verbs":["<verb>"[,...]]}]'
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
description: ""
displayName: ""
rules:
- resources:
- ""
verbs:
- ""
Options
| Flag | Description |
|---|---|
--description string | Description of devspace role |
--devspace string | Devspace of devspace role |
--displayname string | Display name of devspace role |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Create devspace role from a YAML file |
-h, --help | Help for devspacerole |
--name string | Name of devspace role |
--rules string | Access rules associated with devspace role in JSON format e.g. ‘[{"resources": [" "," "], "verbs": [" "," "]}]’ |
--skeleton | Outputs skeleton YAML that can be used with the –file flag |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos create devspacesecret
Create a devspace secret
Synopsis
The kosmos create devspacesecret command is used to create a new devspace secret with specified configurations.
kosmos create devspacesecret [flags]
Examples
kosmos create devspacesecret --file <path-to-yaml-file>
kosmos create devspacesecret --name <devspace-secret-name> --file <path-to-yaml-file> --devspace <devspace-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
data: null
description: ""
displayName: ""
vaultRef:
mountPath: ""
secretPath: ""
Options
| Flag | Description |
|---|---|
--description string | Description of devspace secret |
--devspace string | Devspace of devspace secret |
--displayname string | Display name of devspace secret |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Create devspace secret from a YAML file |
-h, --help | Help for devspacesecret |
--name string | Name of devspace secret |
--skeleton | Outputs skeleton YAML that can be used with the –file flag |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos create devspaceteam
Create a devspace team
Synopsis
The kosmos create devspaceteam command is used to create a new devspace team with specified configurations.
kosmos create devspaceteam [flags]
Examples
kosmos create devspaceteam --file <path-to-yaml-file>
kosmos create devspaceteam --name <devspace-team-name> --file <path-to-yaml-file> --devspace <devspace-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusterRoles:
- name: ""
description: ""
displayName: ""
groups:
- ""
imagePullSecrets:
- apiGroup: ""
key: ""
kind: ""
secretName: ""
secretNamespace: ""
owner:
team: ""
user: ""
username: ""
users:
- ""
Options
| Flag | Description |
|---|---|
--access string | Access rights for users and teams in JSON format e.g. ‘[{"name": " ", "verbs": [" "," "], "subresources": [" "," "], "users": [" "," "], "teams": [" "," "]}]’ |
--clusterroles strings | Names of cluster roles to be assigned to the users (comma separated) |
--description string | Description of devspace team |
--devspace string | Devspace of devspace team |
--displayname string | Display name of devspace team |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Create devspace team from a YAML file |
--groups strings | Groups that belong to the devspace team (comma separated) |
-h, --help | Help for devspaceteam |
--name string | Name of devspace team |
--owner-team string | Owner team |
--owner-user string | Owner user |
--skeleton | Outputs skeleton YAML that can be used with the –file flag |
--username string | Username of devspace team |
--users strings | Users that belong to the devspace team (comma separated) |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos create eks
Create an EKS cluster
Synopsis
The kosmos create eks command is used to create a new Elastic Kubernetes Service (EKS) cluster with specified configurations.
kosmos create eks [flags]
Examples
kosmos create eks --name <eks-cluster-name> --file <path-to-yaml-file>
kosmos create eks --name <eks-cluster-name> --file <path-to-yaml-file> --fleet <fleet-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
authorization:
adminTeams:
- ""
adminUsers:
- ""
binaryAuthorization:
evaluationMode: ""
description: ""
displayName: ""
eksConfig:
bootstrapAccessEntry:
principalArn: ""
clusterRole: ""
deleteOnDetachment: false
displayName: ""
ebsCSIDriver: false
imported: false
kmsKey: ""
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
kosmosRoleArn: ""
kubernetesVersion: ""
loggingTypes:
- ""
nodeGroups:
- arm: false
desiredSize: 0
diskSize: 0
ec2SshKey: ""
gpu: false
imageId: ""
instanceType: ""
labels: null
launchTemplate:
id: ""
name: ""
version: 0
maxSize: 0
minSize: 0
nodeRole: ""
nodegroupName: ""
requestSpotInstances: false
resourceTags: null
spotInstanceTypes:
- ""
subnets:
- ""
tags: null
userData: ""
version: ""
privateAccess: false
publicAccess: false
publicAccessSources:
- ""
region: ""
secretsEncryption: false
securityGroups:
- ""
subnets:
- ""
tags: null
loggingConfig:
componentConfig:
enableComponents:
- ""
monitoringConfig:
managedPrometheusConfig:
enabled: false
managedThanosConfig:
enabled: false
name: ""
oidcConfig:
issuerUri: ""
jwks: ""
owner: ""
Options
| Flag | Description |
|---|---|
--config-deleteondetachment | Delete cluster when detached from kosmos. Required if import is false. (Default true) |
--config-kosmosrolearn string | ARN of the role to manage the EKS cluster |
--config-kubernetesversion string | Required if imported is false |
--description string | Description of EKS cluster |
--displayname string | Display name of EKS cluster |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Create EKS cluster from a YAML file |
--fleet string | Fleet of EKS cluster |
-h, --help | Help for eks |
--name string | Name of EKS cluster |
--skeleton | Outputs skeleton YAML that can be used with the –file flag |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos create eksoidcconnect
Create an EKS OIDC connect
Synopsis
The kosmos create eksoidcconnect command is used to create a new EKS OIDC connect with specified configurations.
kosmos create eksoidcconnect [flags]
Examples
kosmos create eksoidcconnect --name <eks-oidc-connect-name> --file <path-to-yaml-file>
kosmos create eksoidcconnect --name <eks-oidc-connect-name> --file <path-to-yaml-file> --fleet <fleet-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
kosmosRoleArn: ""
name: ""
region: ""
Options
| Flag | Description |
|---|---|
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Create EKS OIDC connect from a YAML file |
--fleet string | Fleet of EKS OIDC connect |
-h, --help | Help for eksoidcconnect |
--jwt-claims string | JWT claims in JSON format e.g. ‘{"aud": " ", "iss": " ", "sub": " "}’ |
--kosmos-role-arn string | ARN of the role used to manage the EKS cluster |
--name string | Name of EKS OIDC connect |
--region string | Region of the cluster |
--skeleton | Outputs skeleton YAML that can be used with the –file flag |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos create fleetclusteraccess
Create a fleet cluster access
Synopsis
The kosmos create fleetclusteraccess command is used to create a new fleet cluster access with specified configurations.
kosmos create fleetclusteraccess [flags]
Examples
kosmos create fleetclusteraccess --name <fleet-cluster-access-name> --file <path-to-yaml-file>
kosmos create fleetclusteraccess --name <fleet-cluster-access-name> --file <path-to-yaml-file> --fleet <fleet-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusters:
- ""
description: ""
displayName: ""
localClusterAccessTemplate:
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
clusterRoles:
- name: ""
description: ""
displayName: ""
priority: 0
teams:
- ""
users:
- team: ""
user: ""
owner:
team: ""
user: ""
Options
| Flag | Description |
|---|---|
--access string | Access rights for users and teams in JSON format e.g. ‘[{"name": " ", "verbs": [" "," "], "subresources": [" "," "], "users": [" "," "], "teams": [" "," "]}]’ |
--clusters strings | Clusters the template should be applied on (comma separated) |
--description string | Description of fleet cluster access |
--displayname string | Display name of fleet cluster access |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Create fleet cluster access from a YAML file |
--fleet string | Fleet of fleet cluster access |
-h, --help | Help for fleetclusteraccess |
--name string | Name of fleet cluster access |
--owner-team string | Owner team |
--owner-user string | Owner user |
--skeleton | Outputs skeleton YAML that can be used with the –file flag |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos create fleetclusterroletemplate
Create a fleet cluster role template
Synopsis
The kosmos create fleetclusterroletemplate command is used to create a new fleet cluster role template with specified configurations.
kosmos create fleetclusterroletemplate [flags]
Examples
kosmos create fleetclusterroletemplate --file <path-to-yaml-file> --name <fleet-cluster-role-template-name>
kosmos create fleetclusterroletemplate --file <path-to-yaml-file> --name <fleet-cluster-role-template-name> --fleet <fleet-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusterRoleTemplate:
aggregationRule:
clusterRoleSelectors:
- matchExpressions:
- key: ""
operator: ""
values:
- ""
matchLabels: null
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
rules:
- apiGroups:
- ""
nonResourceURLs:
- ""
resourceNames:
- ""
resources:
- ""
verbs:
- ""
clusters:
- ""
description: ""
displayName: ""
localClusterRoleTemplate:
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
clusterRoleTemplate:
aggregationRule:
clusterRoleSelectors:
- matchExpressions:
- key: ""
operator: ""
values:
- ""
matchLabels: null
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
rules:
- apiGroups:
- ""
nonResourceURLs:
- ""
resourceNames:
- ""
resources:
- ""
verbs:
- ""
description: ""
displayName: ""
management: false
owner:
team: ""
user: ""
Options
| Flag | Description |
|---|---|
--clusters strings | clusters this template applies on (comma separated) |
--description string | Description of fleet cluster role template (default "desc") |
--displayname string | Display Name of fleet cluster role template |
--dry-run | Outputs yaml template for fleetclusterroletemplate |
-f, --file string | Create fleet cluster role template from a YAML file |
--fleet string | Fleet of fleet cluster role template |
-h, --help | Help for fleetclusterroletemplate |
--management | true if the role template should be in management instance |
-n, --name string | Name of fleet cluster role template |
--owning_team string | Owning team of the fleet |
--owning_user string | Owning user of the fleet |
--skeleton | Outputs skeleton YAML that can be used with the –file flag |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos create fleetrole
Create a fleet role
Synopsis
The kosmos create fleetrole command is used to create a new fleet role with specified configurations.
kosmos create fleetrole [flags]
Examples
kosmos create fleetrole --file <path-to-yaml-file>
kosmos create fleetrole --name <fleet-role-name> --fleet <fleet-name> --rules <resource>=<verb>[,<resource>=<verb>...]
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
description: ""
rules:
- resources:
- ""
verbs:
- ""
Options
| Flag | Description |
|---|---|
--description string | Description of fleet role |
--dry-run | Outputs yaml template for fleetrole |
-f, --file string | Create fleet role from a YAML file |
--fleet string | Name of owning fleet of fleet role |
-h, --help | Help for fleetrole |
--name string | Name of fleet role |
--rules stringToString | Fleet role rules. See examples for more info (default []) |
--skeleton | Outputs skeleton YAML that can be used with the –file flag |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos create fleetsecret
Create a fleet secret
Synopsis
The kosmos create fleetsecret command is used to create a new fleet secret with specified configurations.
kosmos create fleetsecret [flags]
Examples
kosmos create fleetsecret --file <path-to-yaml-file>
kosmos create fleetsecret --name <fleet-secret-name> --file <path-to-yaml-file> --fleet <fleet-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
data: null
description: ""
displayName: ""
name: ""
namespace: ""
vaultRef:
mountPath: ""
secretPath: ""
Options
| Flag | Description |
|---|---|
--description string | Description of fleet secret |
--displayname string | Display name of fleet secret |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Create fleet secret from a YAML file |
--fleet string | Fleet of fleet secret |
-h, --help | Help for fleetsecret |
--name string | Name of fleet secret |
--secretname string | Name of secret in connected clusters |
--secretnamespace string | Namespace of secret in connected clusters |
--skeleton | Outputs skeleton YAML that can be used with the –file flag |
--vaultmountpath string | Vault mount path for fleet secret |
--vaultsecretpath string | Vault secret path for fleet secret |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos create fleetspacetemplate
Create a fleet space template
Synopsis
The kosmos create fleetspacetemplate command is used to create a new fleet space template with specified configurations.
kosmos create fleetspacetemplate [flags]
Examples
kosmos create fleetspacetemplate --name <fleet-space-template-name> --file <path-to-yaml-file>
kosmos create fleetspacetemplate --name <fleet-space-template-name> --file <path-to-yaml-file> --fleet <fleet-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
description: ""
displayName: ""
owner:
team: ""
user: ""
parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
template:
apps:
- name: ""
namespace: ""
parameters: ""
releaseName: ""
version: ""
charts:
- insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
releaseName: ""
releaseNamespace: ""
repoURL: ""
timeout: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
values: ""
version: ""
wait: false
instanceTemplate:
metadata:
annotations: null
labels: null
metadata:
annotations: null
labels: null
objects: ""
versions:
- parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
template:
apps:
- name: ""
namespace: ""
parameters: ""
releaseName: ""
version: ""
charts:
- insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
releaseName: ""
releaseNamespace: ""
repoURL: ""
timeout: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
values: ""
version: ""
wait: false
instanceTemplate:
metadata:
annotations: null
labels: null
metadata:
annotations: null
labels: null
objects: ""
version: ""
Options
| Flag | Description |
|---|---|
--description string | Description of fleet space template (default "desc") |
--displayname string | Display Name of fleet space template |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Create fleet space template from a YAML file |
--fleet string | Fleet of fleet space template |
-h, --help | Help for fleetspacetemplate |
-n, --name string | Name of fleet space template |
--owner-team string | Owner team |
--owner-user string | Owner user |
--skeleton | Outputs skeleton YAML that can be used with the –file flag |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos create fleetteam
Create a fleet team
Synopsis
The kosmos create fleetteam command is used to create a new fleet team with specified configurations.
kosmos create fleetteam [flags]
Examples
kosmos create fleetteam --file <path-to-yaml-file>
kosmos create fleetteam --name <fleet-team-name> --fleet <fleet-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusterRoles:
- name: ""
description: ""
displayName: ""
groups:
- ""
imagePullSecrets:
- apiGroup: ""
key: ""
kind: ""
secretName: ""
secretNamespace: ""
owner:
team: ""
user: ""
username: ""
users:
- ""
Options
| Flag | Description |
|---|---|
--access string | Access rights for users and teams in JSON format e.g. ‘[{"name": " ", "verbs": [" "," "], "subresources": [" "," "], "users": [" "," "], "teams": [" "," "]}]’ |
--clusterroles strings | Names of cluster roles to be assigned to the users (comma separated) |
--description string | Description of fleet team |
--displayname string | Display name of fleet team |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Create fleet team from a YAML file |
--fleet string | Fleet of fleet team |
--groups strings | Groups that belong to fleet team (comma separated) |
-h, --help | Help for fleetteam |
--name string | Name of fleet team |
--owner-team string | Owner team |
--owner-user string | Owner user |
--skeleton | Outputs skeleton YAML that can be used with the –file flag |
--username string | Username of fleet team |
--users strings | Users that belong to fleet team (comma separated) |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos create genericcluster
Create a generic cluster
Synopsis
The kosmos create genericcluster command is used to create a new generic cluster with specified configurations.
kosmos create genericcluster [flags]
Examples
kosmos create genericcluster --name <generic-cluster-name> --file <path-to-yaml-file>
kosmos create genericcluster --name <generic-cluster-name> --file <path-to-yaml-file> --fleet <fleet-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
authorization:
adminTeams:
- ""
adminUsers:
- ""
binaryAuthorization:
evaluationMode: ""
description: ""
displayName: ""
kubeConfig: ""
loggingConfig:
componentConfig:
enableComponents:
- ""
monitoringConfig:
managedPrometheusConfig:
enabled: false
managedThanosConfig:
enabled: false
name: ""
oidcConfig:
issuerUri: ""
jwks: ""
owner: ""
proxyConfig:
kubernetesSecret:
name: ""
namespace: ""
Options
| Flag | Description |
|---|---|
--cluster-region string | Region of generic cluster |
--description string | Description of generic cluster |
--displayname string | Display name of generic cluster |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Create generic cluster from a YAML file |
--fleet string | Fleet of generic cluster |
-h, --help | Help for genericcluster |
--kubeconfig string | Kubernetes config used to connect the cluster |
--kubernetes-version string | Kubernetes version of generic cluster |
--name string | Name of generic cluster |
--owner string | Owner of generic cluster |
--skeleton | Outputs skeleton YAML that can be used with the –file flag |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos create gke
Create a GKE cluster
Synopsis
The kosmos create gke command is used to create a new Google Kubernetes Engine (GKE) cluster with specified configurations.
kosmos create gke [flags]
Examples
kosmos create gke --name <gke-cluster-name> --file <path-to-yaml-file>
kosmos create gke --name <gke-cluster-name> --file <path-to-yaml-file> fleet <fleet-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
authorization:
adminTeams:
- ""
adminUsers:
- ""
binaryAuthorization:
evaluationMode: ""
description: ""
displayName: ""
gkeConfig:
autopilotConfig:
enabled: false
clusterAddons:
horizontalPodAutoscaling: false
httpLoadBalancing: false
networkPolicyConfig: false
clusterIpv4Cidr: ""
clusterName: ""
deleteOnDetachment: false
description: ""
enableKubernetesAlpha: false
googleCredentialSecret: ""
imported: false
ipAllocationPolicy:
clusterIpv4CidrBlock: ""
clusterSecondaryRangeName: ""
createSubnetwork: false
nodeIpv4CidrBlock: ""
servicesIpv4CidrBlock: ""
servicesSecondaryRangeName: ""
subnetworkName: ""
useIpAliases: false
keyName: ""
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
kubernetesVersion: ""
labels: null
locations:
- ""
loggingService: ""
maintenanceWindow: ""
masterAuthorizedNetworks:
cidrBlocks:
- cidrBlock: ""
displayName: ""
enabled: false
monitoringService: ""
network: ""
networkPolicyEnabled: false
nodePools:
- autoscaling:
enabled: false
maxNodeCount: 0
minNodeCount: 0
config:
diskSizeGb: 0
diskType: ""
imageType: ""
labels: null
localSsdCount: 0
machineType: ""
oauthScopes:
- ""
preemptible: false
tags:
- ""
taints:
- effect: ""
key: ""
value: ""
initialNodeCount: 0
management:
autoRepair: false
autoUpgrade: false
maxPodsConstraint: 0
name: ""
version: ""
privateClusterConfig:
enablePrivateEndpoint: false
enablePrivateNodes: false
masterIpv4CidrBlock: ""
projectID: ""
projectNumber: ""
region: ""
serviceAccount: ""
subnetwork: ""
workloadIdentityPoolId: ""
workloadIdentityProviderId: ""
zone: ""
loggingConfig:
componentConfig:
enableComponents:
- ""
monitoringConfig:
managedPrometheusConfig:
enabled: false
managedThanosConfig:
enabled: false
name: ""
owner: ""
Options
| Flag | Description |
|---|---|
--config-deleteondetachment | (Default true) |
--description string | Description of GKE cluster |
--displayname string | Display name of GKE cluster |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Create GKE cluster from a YAML file |
--fleet string | Fleet of GKE cluster |
-h, --help | Help for gke |
--name string | Name of GKE cluster |
--skeleton | Outputs skeleton YAML that can be used with the –file flag |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos create gkeoidcconnect
Create a GKE OIDC connect
Synopsis
The kosmos create gkeoidcconnect command is used to create a new GKE OIDC connect with specified configurations.
kosmos create gkeoidcconnect [flags]
Examples
kosmos create gkeoidcconnect --name <gke-oidc-connect-name> --file <path-to-yaml-file>
kosmos create gkeoidcconnect --name <gke-oidc-connect-name> --file <path-to-yaml-file> --fleet <fleet-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
name: ""
projectNumber: ""
serviceAccount: ""
workloadIdentityPoolId: ""
workloadIdentityProviderId: ""
Options
| Flag | Description |
|---|---|
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Create GKE OIDC connect from a YAML file |
--fleet string | Fleet of GKE OIDC connect |
-h, --help | Help for gkeoidcconnect |
--jwt-claims string | JWT claims in JSON format e.g. ‘{"aud": " ", "iss": " ", "sub": " "}’ |
--name string | Name of GKE OIDC connect |
--project-number string | Project number |
--service-account string | Service account for GKE OIDC connect |
--skeleton | Outputs skeleton YAML that can be used with the –file flag |
--workload-identity-pool-id string | Workload identity pool ID |
--workload-identity-provider-id string | Workload identity provider ID |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos create mks
Create an MKS cluster
Synopsis
The kosmos create mks command is used to create a new Managed Kubernetes Service (MKS) cluster with specified configurations.
kosmos create mks [flags]
Examples
kosmos create mks --name <mks-cluster-name> --file <path-to-yaml-file>
kosmos create mks --name <mks-cluster-name> --file <path-to-yaml-file> --fleet <fleet-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
authorization:
adminTeams:
- ""
adminUsers:
- ""
binaryAuthorization:
evaluationMode: ""
description: ""
displayName: ""
loggingConfig:
componentConfig:
enableComponents:
- ""
mksConfig:
clusterRole: ""
deleteOnDetachment: false
displayName: ""
ebsCSIDriver: false
imported: false
kmsKey: ""
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
kosmosRoleArn: ""
kubernetesVersion: ""
loggingTypes:
- ""
nodeGroups:
- desiredSize: 0
diskSize: 0
ec2SshKey: ""
gpu: false
imageId: ""
instanceType: ""
labels: null
launchTemplate:
id: ""
name: ""
version: 0
maxSize: 0
minSize: 0
nodeRole: ""
nodegroupName: ""
requestSpotInstances: false
resourceTags: null
spotInstanceTypes:
- ""
subnets:
- ""
tags: null
userData: ""
version: ""
privateAccess: false
publicAccess: false
publicAccessSources:
- ""
region: ""
secretsEncryption: false
securityGroups:
- ""
subnets:
- ""
tags: null
monitoringConfig:
managedPrometheusConfig:
enabled: false
managedThanosConfig:
enabled: false
name: ""
oidcConfig:
issuerUri: ""
jwks: ""
owner: ""
Options
| Flag | Description |
|---|---|
--config-deleteondetachment | Delete cluster when detached from kosmos. Required if import is false. (Default true) |
--config-kosmosrolearn string | ARN of the role to manage the MKS cluster. |
--config-kubernetesversion string | Required if imported is false |
--description string | Description of MKS cluster |
--displayname string | Display name of MKS cluster |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Create MKS cluster from a YAML file |
--fleet string | Fleet of MKS cluster |
-h, --help | Help for mks |
--name string | Name of MKS cluster |
--skeleton | Outputs skeleton YAML that can be used with the –file flag |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos create mksoidcconnect
Create an MKS OIDC connect
Synopsis
The kosmos create mksoidcconnect command is used to create a new MKS OIDC connect with specified configurations.
kosmos create mksoidcconnect [flags]
Examples
kosmos create mksoidcconnect --name <mks-oidc-connect-name> --file <path-to-yaml-file>
kosmos create mksoidcconnect --name <mks-oidc-connect-name> --file <path-to-yaml-file> --fleet <fleet-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
kosmosRoleArn: ""
name: ""
region: ""
Options
| Flag | Description |
|---|---|
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Create MKS OIDC connect from a YAML file |
--fleet string | Fleet of MKS OIDC connect |
-h, --help | Help for mksoidcconnect |
--jwt-claims string | JWT claims in JSON format e.g. ‘{"aud": " ", "iss": " ", "sub": " "}’ |
--kosmos-role-arn string | ARN of the role used to manage the MKS cluster |
--name string | Name of MKS OIDC connect |
--region string | Region of cluster |
--skeleton | Outputs skeleton YAML that can be used with the –file flag |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos create vaultconfiguration
Create a vault configuration
Synopsis
The kosmos create vaultconfiguration command is used to create a new vault configuration with specified configurations.
kosmos create vaultconfiguration [flags]
Examples
kosmos create vaultconfiguration --name <vault-configuration-name> --file <path-to-yaml-file> --devspace <devspace-name>
kosmos create vaultconfiguration --name <vault-configuration-name> --file <path-to-yaml-file> --fleet <fleet-name>
kosmos create vaultconfiguration --name <vault-configuration-name> --file <path-to-yaml-file>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
address: ""
auth:
token: ""
tokenSecretRef:
key: ""
name: ""
optional: false
enabled: false
syncInterval: ""
Options
| Flag | Description |
|---|---|
--address string | Address of vault configuration |
--auth-secret-key string | Auth secret key of vault configuration |
--auth-secret-name string | Auth secret name of vault configuration |
--auth-token string | Auth token of vault configuration |
--devspace string | DevSpace of vault configuration |
--dry-run | Outputs the yaml that would be sent as the request payload |
--enabled | Whether vault configuration is enabled |
-f, --file string | Create vault configuration from a YAML file |
--fleet string | Fleet of vault configuration |
-h, --help | Help for vaultconfiguration |
--name string | Name of vault configuration |
--skeleton | Outputs skeleton YAML that can be used with the –file flag |
--sync-interval string | Sync interval of vault configuration |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos create vcluster
Create a virtual cluster
Synopsis
The kosmos create vcluster command is used to create a new virtual cluster with specified configurations.
kosmos create vcluster [flags]
Examples
kosmos create vcluster --name <virtual-cluster-name>
kosmos create vcluster --name <virtual-cluster-name> --devspace <devspace-name>
kosmos create vcluster --name <virtual-cluster-name> --devspace <devspace-name> --cluster <cluster-name>
kosmos create vcluster --file <path-to-yaml-file>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- devSpaceTeams:
- ""
name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusterRef:
cluster: ""
namespace: ""
virtualCluster: ""
deletionProtection: false
description: ""
displayName: ""
extraAccessRules:
- clusterRole: ""
devSpaceTeams:
- ""
teams:
- ""
users:
- ""
owner:
team: ""
user: ""
parameters: ""
sleepModeConfig:
deleteAfter: 0
forceSleep: false
forceSleepDuration: 0
ignoreActiveConnections: false
ignoreAll: false
ignoreGroups: ""
ignoreIngresses: false
ignoreResourceNames: ""
ignoreResourceVerbs: ""
ignoreResources: ""
ignoreUserAgents: ""
ignoreVClusters: false
ignoreVerbs: ""
sleepAfter: 0
sleepSchedule: ""
timezone: ""
wakeupSchedule: ""
templateRef:
name: ""
syncOnce: false
version: ""
Options
| Flag | Description |
|---|---|
--annotations strings | Comma separated annotations to apply to the virtualcluster |
--cluster string | The cluster to create the virtual cluster in |
--create-context | If Kosmos should create a kube context for the space. (Default true) |
--description string | The description to show in the UI for this virtual cluster |
-d, --devspace string | The DevSpace to use (default "b") |
--disable-direct-cluster-endpoint | When enabled does not use an available direct cluster endpoint to connect to the vcluster |
--display-name string | The display name to show in the UI for this virtual cluster |
--dry-run | Outputs yaml template for virtual cluster |
-f, --file string | Create virtual cluster from a YAML file |
-h, --help | Help for vcluster |
-l, --labels strings | Comma separated labels to apply to the virtualcluster |
--link strings | Labeled Links to annotate the object with. |
-n, --name string | Name of virtual cluster |
--parameters string | The file where the parameter values for the apps are specified |
--print | If enabled, prints the context to the console |
--recreate | If enabled and there already exists a virtual cluster with this name, Kosmos will delete it first |
--set strings | Allows specific template parameters to be set. E.g. –set myParameter=myValue |
--skeleton | Outputs skeleton YAML that can be used with the –file flag |
--skip-wait | If true, will not wait until the virtual cluster is running |
--space string | The space to create the virtual cluster in |
--switch-context | If kosmos should switch the current context to the new context. (Default true) |
--team string | The team to create the space for |
--template string | The virtual cluster template to use to create the virtual cluster |
--update | If enabled and a virtual cluster already exists, will update the template, version and parameters |
--use | If kosmos should use the virtual cluster if its already there |
--user string | The user to create the space for |
--version string | The template version to use |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos create vclustertemplate
Create a virtual cluster template
Synopsis
The kosmos create vclustertemplate command is used to create a new virtual cluster template with specified configurations.
kosmos create vclustertemplate [flags]
Examples
kosmos create vclustertemplate --file <path-to-yaml-file>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- devSpaceTeams:
- ""
name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
description: ""
displayName: ""
owner:
team: ""
user: ""
parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
template:
access:
defaultClusterRole: ""
rules:
- clusterRole: ""
devSpaceTeams:
- ""
teams:
- ""
users:
- ""
accessPoint:
ingress:
enabled: false
apps:
- name: ""
namespace: ""
parameters: ""
releaseName: ""
version: ""
charts:
- insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
releaseName: ""
releaseNamespace: ""
repoURL: ""
timeout: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
values: ""
version: ""
wait: false
forwardToken: false
helmRelease:
chart:
name: ""
password: ""
repo: ""
username: ""
version: ""
values: ""
instanceTemplate:
deletionProtection: false
metadata:
annotations: null
labels: null
sleepModeConfig:
deleteAfter: 0
forceSleep: false
forceSleepDuration: 0
ignoreActiveConnections: false
ignoreAll: false
ignoreGroups: ""
ignoreIngresses: false
ignoreResourceNames: ""
ignoreResourceVerbs: ""
ignoreResources: ""
ignoreUserAgents: ""
ignoreVClusters: false
ignoreVerbs: ""
sleepAfter: 0
sleepSchedule: ""
timezone: ""
wakeupSchedule: ""
metadata:
annotations: null
labels: null
objects: ""
pro:
enabled: false
spaceTemplate:
apps:
- name: ""
namespace: ""
parameters: ""
releaseName: ""
version: ""
charts:
- insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
releaseName: ""
releaseNamespace: ""
repoURL: ""
timeout: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
values: ""
version: ""
wait: false
metadata:
annotations: null
labels: null
objects: ""
versions:
- parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
template:
access:
defaultClusterRole: ""
rules:
- clusterRole: ""
devSpaceTeams:
- ""
teams:
- ""
users:
- ""
accessPoint:
ingress:
enabled: false
apps:
- name: ""
namespace: ""
parameters: ""
releaseName: ""
version: ""
charts:
- insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
releaseName: ""
releaseNamespace: ""
repoURL: ""
timeout: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
values: ""
version: ""
wait: false
forwardToken: false
helmRelease:
chart:
name: ""
password: ""
repo: ""
username: ""
version: ""
values: ""
instanceTemplate:
deletionProtection: false
metadata:
annotations: null
labels: null
sleepModeConfig:
deleteAfter: 0
forceSleep: false
forceSleepDuration: 0
ignoreActiveConnections: false
ignoreAll: false
ignoreGroups: ""
ignoreIngresses: false
ignoreResourceNames: ""
ignoreResourceVerbs: ""
ignoreResources: ""
ignoreUserAgents: ""
ignoreVClusters: false
ignoreVerbs: ""
sleepAfter: 0
sleepSchedule: ""
timezone: ""
wakeupSchedule: ""
metadata:
annotations: null
labels: null
objects: ""
pro:
enabled: false
spaceTemplate:
apps:
- name: ""
namespace: ""
parameters: ""
releaseName: ""
version: ""
charts:
- insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
releaseName: ""
releaseNamespace: ""
repoURL: ""
timeout: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
values: ""
version: ""
wait: false
metadata:
annotations: null
labels: null
objects: ""
version: ""
Options
| Flag | Description |
|---|---|
--access string | Access rights for users and teams in JSON format e.g. ‘[{"name": " ", "verbs": [" "," "], "subresources": [" "," "], "users": [" "," "], "teams": [" "," "]}]’ |
--description string | Description of virtual cluster template (default "desc") |
--displayname string | Display name of virtual cluster template |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Create virtual cluster template from a YAML file |
-h, --help | Help for vclustertemplate |
-n, --name string | Name of virtual cluster template |
--owner-team string | Owner team |
--owner-user string | Owner user |
--skeleton | Outputs skeleton YAML that can be used with the –file flag |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos defaults
Manage default values for commands
Synopsis
The kosmos defaults command is used to set or manage default values for kosmos/kosmosctl command, ensuring consistent configuration across your operations.
Options
| Flag | Description |
|---|---|
-h, --help | Help for defaults |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos defaults get
Get a default value configured for commands
Synopsis
The kosmos defaults get command is used to retrieve a specific default value that has been configured for kosmos/kosmosctl commands.
kosmos defaults get [flags]
Examples
kosmos defaults get <key>
Supported keys are:
project
devspace
fleet
Options
| Flag | Description |
|---|---|
-h, --help | Help for get |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos defaults set
Set default value for commands
Synopsis
The kosmos defaults set command is used to set a default value for kosmos/kosmosctl commands.
kosmos defaults set [flags]
Examples
kosmos defaults set <key> <value>
Supported keys are:
project
devspace
fleet
Options
| Flag | Description |
|---|---|
-h, --help | Help for set |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos defaults view
View all defaults values for commands
Synopsis
The kosmos defaults view command is used to view all default values configured for kosmos/kosmosctl commands.
kosmos defaults view [flags]
Examples
kosmos defaults view
Options
| Flag | Description |
|---|---|
-h, --help | Help for view |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos delete
Delete Kosmos resources
Synopsis
The kosmos delete command is used to delete various resources from Kosmos.
Options
| Flag | Description |
|---|---|
-h, --help | Help for delete |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos delete aks
Delete an AKS cluster
Synopsis
The kosmos delete aks command is used to delete an existing Azure Kubernetes Service (AKS) cluster.
kosmos delete aks [flags]
Examples
kosmos delete aks --name <aks-cluster-name> --fleet <fleet-name>
kosmos delete aks --name <aks-cluster-name> # Requires default fleet value to be set
Options
| Flag | Description |
|---|---|
--fleet string | Fleet to delete the AKS cluster from |
-h, --help | Help for aks |
-n, --name string | Name of AKS cluster |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos delete aksoidcconnect
Delete an AKS OIDC connect
Synopsis
The kosmos delete aksoidcconnect command is used to delete an existing AKS OIDC connect.
kosmos delete aksoidcconnect [flags]
Examples
kosmos delete aksoidcconnect --name <aks-oidc-connect-name> --fleet <fleet-name>
kosmos delete aksoidcconnect --name <aks-oidc-connect-name> # Requires default fleet value to be set
Options
| Flag | Description |
|---|---|
--fleet string | Fleet of the AKS OIDC connect |
-h, --help | Help for aksoidcconnect |
-n, --name string | Name of AKS OIDC connect |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos delete app
Delete an app
Synopsis
The kosmos delete app command is used to delete an existing app.
kosmos delete app [flags]
Examples
kosmos delete app --name <app-name>
Options
| Flag | Description |
|---|---|
-h, --help | Help for app |
-n, --name string | Name of app |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos delete clusterroletemplate
Delete a cluster role template
Synopsis
The kosmos delete clusterroletemplate command is used to delete an existing cluster role template.
kosmos delete clusterroletemplate [flags]
Examples
kosmos delete clusterroletemplate --name <cluster-role-template-name>
Options
| Flag | Description |
|---|---|
-h, --help | Help for clusterroletemplate |
-n, --name string | Name of cluster role template |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos delete devspaceclusteraccess
Delete a devspace cluster access
Synopsis
The kosmos delete devspaceclusteraccess command is used to delete an existing devspace cluster access.
kosmos delete devspaceclusteraccess [flags]
Examples
kosmos delete devspaceclusteraccess --name <devspace-cluster-access-name> --devspace <devspace-name>
kosmos delete devspaceclusteraccess --name <devspace-cluster-access-name> # Requires default devspace value to be set
Options
| Flag | Description |
|---|---|
--devspace string | Devspace to delete the devspace cluster access from |
-h, --help | Help for devspaceclusteraccess |
-n, --name string | Name of devspace cluster access |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos delete devspacerole
Delete a devspace role
Synopsis
The kosmos delete devspacerole command is used to delete an existing devspace role.
kosmos delete devspacerole [flags]
Examples
kosmos delete devspacerole --name <devspace-role-name> --devspace <devspace-name>
kosmos delete devspacerole --name <devspace-role-name> # Requires default devspace value to be set
Options
| Flag | Description |
|---|---|
--devspace string | Devspace to delete the devspace role from |
-h, --help | Help for devspacerole |
-n, --name string | Name of devspace role |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos delete devspacesecret
Delete a devspace secret
Synopsis
The kosmos delete devspacesecret command is used to delete an existing devspace secret.
kosmos delete devspacesecret [flags]
Examples
kosmos delete devspacesecret --name <devspace-secret-name> --devspace <devspace-name>
kosmos delete devspacesecret --name <devspace-secret-name> # Requires default devspace value to be set
Options
| Flag | Description |
|---|---|
--devspace string | Devspace to delete the devspace secret from |
-h, --help | Help for devspacesecret |
-n, --name string | Name of devspace secret |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos delete devspaceteam
Delete a devspace team
Synopsis
The kosmos delete devspaceteam command is used to delete an existing devspace team.
kosmos delete devspaceteam [flags]
Examples
kosmos delete devspaceteam --name <devspace-team-name> --devspace <devspace-name>
kosmos delete devspaceteam --name <devspace-team-name> # Requires default devspace value to be set
Options
| Flag | Description |
|---|---|
--devspace string | Devspace to delete the devspace team from |
-h, --help | Help for devspaceteam |
-n, --name string | Name of devspace team |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos delete eks
Delete an EKS cluster
Synopsis
The kosmos delete eks command is used to delete an existing Elastic Kubernetes Service (EKS) cluster.
kosmos delete eks [flags]
Examples
kosmos delete eks --name <eks-cluster-name> --fleet <fleet-name>
kosmos delete eks --name <eks-cluster-name> # Requires default fleet value to be set
Options
| Flag | Description |
|---|---|
--fleet string | Fleet to delete the EKS cluster from |
-h, --help | Help for eks |
-n, --name string | Name of EKS cluster |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos delete eksoidcconnect
Delete an EKS OIDC connect
Synopsis
The kosmos delete eksoidcconnect command is used to delete an existing EKS OIDC connect.
kosmos delete eksoidcconnect [flags]
Examples
kosmos delete eksoidcconnect --name <eks-oidc-connect-name> --fleet <fleet-name>
kosmos delete eksoidcconnect --name <eks-oidc-connect-name> # Requires default fleet value to be set
Options
| Flag | Description |
|---|---|
--fleet string | Fleet of the EKS OIDC connect |
-h, --help | Help for eksoidcconnect |
-n, --name string | Name of EKS OIDC connect |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos delete fleetclusteraccess
Delete a fleet cluster access
Synopsis
The kosmos delete fleetclusteraccess command is used to delete an existing fleet cluster access.
kosmos delete fleetclusteraccess [flags]
Examples
kosmos delete fleetclusteraccess --name <fleet-cluster-access-name> --fleet <fleet-name>
kosmos delete fleetclusteraccess --name <fleet-cluster-access-name> # Requires default fleet value to be set
Options
| Flag | Description |
|---|---|
--fleet string | Fleet name to delete the fleet cluster access from |
-h, --help | Help for fleetclusteraccess |
-n, --name string | Name of fleet cluster access |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos delete fleetclusterroletemplate
Delete a fleet cluster role template
Synopsis
The kosmos delete fleetclusterroletemplate command is used to delete an existing fleet cluster role template.
kosmos delete fleetclusterroletemplate [flags]
Examples
kosmos delete fleetclusterroletemplate --name <fleet-cluster-role-template-name> --fleet <fleet-name>
Options
| Flag | Description |
|---|---|
--fleet string | Fleet of fleet cluster role template |
-h, --help | Help for fleetclusterroletemplate |
-n, --name string | Name of fleet cluster role template |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos delete fleetrole
Delete a fleet role
Synopsis
The kosmos delete fleetrole command is used to delete an existing fleet role.
kosmos delete fleetrole [flags]
Examples
kosmos delete fleetrole --name <fleet-role-name> --fleet <fleet-name>
kosmos delete fleetrole --name <fleet-role-name> # Requires default fleet value to be set
Options
| Flag | Description |
|---|---|
--fleet string | Fleet to delete the fleet role from |
-h, --help | Help for fleetrole |
--name string | Name of fleet role |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos delete fleetsecret
Delete a fleet secret
Synopsis
The kosmos delete fleetsecret command is used to delete an existing fleet secret.
kosmos delete fleetsecret [flags]
Examples
kosmos delete fleetsecret --name <fleet-secret-name> --fleet <fleet-name>
Options
| Flag | Description |
|---|---|
--fleet string | Fleet to delete the fleet secret from |
-h, --help | Help for fleetsecret |
-n, --name string | Name of fleet secret |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos delete fleetspacetemplate
Delete a fleet space template
Synopsis
The kosmos delete fleetspacetemplate command is used to delete an existing fleet space template.
kosmos delete fleetspacetemplate [flags]
Examples
kosmos delete fleetspacetemplate --name <fleet-space-template-name> --fleet <fleet-name>
kosmos delete fleetspacetemplate --name <fleet-space-template-name> # Requires default fleet value to be set
Options
| Flag | Description |
|---|---|
--fleet string | Fleet name to delete the fleet space template from |
-h, --help | Help for fleetspacetemplate |
-n, --name string | Name of fleet space template |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos delete fleetteam
Delete a fleet team
Synopsis
The kosmos delete fleetteam command is used to delete an existing fleet team.
kosmos delete fleetteam [flags]
Examples
kosmos delete fleetteam --name <fleet-team-name> --fleet <fleet-name>
kosmos delete fleetteam --name <fleet-team-name> # Requires default fleet value to be set
Options
| Flag | Description |
|---|---|
--fleet string | Fleet to delete the fleet team from |
-h, --help | Help for fleetteam |
--name string | Name of fleet team |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos delete genericcluster
Delete a generic cluster
Synopsis
The kosmos delete genericcluster command is used to delete an existing generic cluster.
kosmos delete genericcluster [flags]
Examples
kosmos delete genericcluster --name <generic-cluster-name> --fleet <fleet-name>
kosmos delete genericcluster --name <generic-cluster-name> # Requires default fleet value to be set
Options
| Flag | Description |
|---|---|
--fleet string | Fleet to delete the generic cluster from |
-h, --help | Help for genericcluster |
-n, --name string | Name of generic cluster |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos delete gke
Delete a GKE cluster
Synopsis
The kosmos delete gke command is used to delete an existing Google Kubernetes Engine (GKE) cluster.
kosmos delete gke [flags]
Examples
kosmos delete gke --name <gke-cluster-name> --fleet <fleet-name>
kosmos delete gke --name <gke-cluster-name> # Requires default fleet value to be set
Options
| Flag | Description |
|---|---|
--fleet string | Fleet to delete the GKE cluster from |
-h, --help | Help for gke |
-n, --name string | Name of GKE cluster |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos delete gkeoidcconnect
Delete a GKE OIDC connect
Synopsis
The kosmos delete gkeoidcconnect command is used to delete an existing GKE OIDC connect.
kosmos delete gkeoidcconnect [flags]
Examples
kosmos delete gkeoidcconnect --name <gke-oidc-connect-name> --fleet <fleet-name>
kosmos delete gkeoidcconnect --name <gke-oidc-connect-name> # Requires default fleet value to be set
Options
| Flag | Description |
|---|---|
--fleet string | Fleet of the GKE OIDC connect |
-h, --help | Help for gkeoidcconnect |
-n, --name string | Name of GKE OIDC connect |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos delete mks
Delete an MKS cluster
Synopsis
The kosmos delete mks command is used to delete an existing Managed Kubernetes Service (MKS) cluster.
kosmos delete mks [flags]
Examples
kosmos delete mks --name <mks-cluster-name> --fleet <fleet-name>
kosmos delete mks --name <mks-cluster-name> # Requires default fleet value to be set
Options
| Flag | Description |
|---|---|
--fleet string | Fleet to delete the MKS cluster from |
-h, --help | Help for mks |
-n, --name string | Name of MKS cluster |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos delete mksoidcconnect
Delete an MKS OIDC connect
Synopsis
The kosmos delete mksoidcconnect command is used to delete an existing MKS OIDC connect.
kosmos delete mksoidcconnect [flags]
Examples
kosmos delete mksoidcconnect --name <mks-oidc-connect-name> --fleet <fleet-name>
kosmos delete mksoidcconnect --name <mks-oidc-connect-name> # Requires default fleet value to be set
Options
| Flag | Description |
|---|---|
--fleet string | Fleet of the MKS OIDC connect |
-h, --help | Help for mksoidcconnect |
-n, --name string | Name of MKS OIDC connect |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos delete vaultconfiguration
Delete a vault configuration
Synopsis
The kosmos delete vaultconfiguration command is used to delete an existing vault configuration.
kosmos delete vaultconfiguration [flags]
Examples
kosmos delete vaultconfiguration --name <vault-configuration-name> --devspace <devspace-name>
kosmos delete vaultconfiguration --name <vault-configuration-name> --fleet <fleet-name>
Options
| Flag | Description |
|---|---|
--devspace string | Devspace associated with vault configuration |
--fleet string | Fleet associated with vault configuration |
-h, --help | Help for vaultconfiguration |
-n, --name string | Name of vault configuration |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos delete vcluster
Delete a virtual cluster
Synopsis
The kosmos delete vcluster command is used to delete an existing virtual cluster.
kosmos delete vcluster [flags]
Examples
kosmos delete vcluster --name <virtual-cluster-name> --devspace <devspace-name>
kosmos delete vcluster --name <virtual-cluster-name> # Requires default devspace value to be set
Options
| Flag | Description |
|---|---|
--delete-context | If the corresponding kube context should be deleted if there is any. (Default true) |
-d, --devspace string | Devspace to get virtual cluster from |
-h, --help | Help for vcluster |
-n, --name string | Name of virtual cluster |
--wait | Termination of this command waits for space to be deleted. Without the flag delete-space, this flag has no effect. |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos delete vclustertemplate
Delete a virtual cluster template
Synopsis
The kosmos delete vclustertemplate command is used to delete an existing virtual cluster template.
kosmos delete vclustertemplate [flags]
Examples
kosmos delete vclustertemplate --name <virtual-cluster-template-name>
Options
| Flag | Description |
|---|---|
-h, --help | Help for vclustertemplate |
-n, --name string | Name of virtual cluster template |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos disconnect
Disconnect from current Kosmos context and switch back to previous kube context
Synopsis
The kosmos disconnect command is used to disconnect from current Kosmos context and switch back to previous kube context.
kosmos disconnect [flags]
Examples
kosmos disconnect
Options
| Flag | Description |
|---|---|
-h, --help | Help for disconnect |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos generate
Generate configuration
Synopsis
The kosmos generate command is used to generate configuration files or outputs for Kosmos.
Options
| Flag | Description |
|---|---|
-h, --help | Help for generate |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos generate admin-kube-config
Generate a new kubeconfig to connect a cluster to Kosmos
Synopsis
The kosmos generate admin-kube-config command is used to generate a new kubeconfig to connect a cluster to Kosmos.
kosmos generate admin-kube-config [flags]
Examples
kosmos generate admin-kube-config
kosmos generate admin-kube-config --namespace <namespace>
Options
| Flag | Description |
|---|---|
-h, --help | Help for admin-kube-config |
--namespace string | The namespace to generate the service account in. The namespace will be created if it does not exist (default "loft") |
--service-account string | The service account name to create (default "loft-admin") |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos generate doc
Generate documentation for CLI
Synopsis
The kosmos generate doc command is used to generate documentation for Kosmos CLI commands.
kosmos generate doc [flags]
Examples
kosmos generate doc
kosmos generate doc --path ./docs
Options
| Flag | Description |
|---|---|
-h, --help | Help for doc |
--path string | The path to write the generated documentation to (default "./docs") |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos generate table
Generate table of available commands
Synopsis
The kosmos generate table command is used to generate table of available commands.
kosmos generate table [flags]
Examples
kosmos generate table
Options
| Flag | Description |
|---|---|
-h, --help | Help for table |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get
Get Kosmos resources
Synopsis
The kosmos get command is used to retrieve various configuration details from the Kosmos environment.
Options
| Flag | Description |
|---|---|
-h, --help | Help for get |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get aks
Get an AKS cluster
Synopsis
The kosmos get aks command is used to retrieve details about a specified Azure Kubernetes Service (AKS) cluster.
kosmos get aks [flags]
Examples
kosmos get aks --name <aks-cluster-name> --fleet <fleet-name>
kosmos get aks --name <aks-cluster-name> # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
aksConfig:
authBaseUrl: ""
authorizedIpRanges:
- ""
baseUrl: ""
clientID: ""
clusterName: ""
deleteOnDetachment: false
dnsPrefix: ""
dnsServiceIp: ""
httpApplicationRouting: false
imported: false
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
kubernetesVersion: ""
linuxAdminUsername: ""
loadBalancerSku: ""
logAnalyticsWorkspaceGroup: ""
logAnalyticsWorkspaceName: ""
managedIdentity: false
monitoring: false
networkPlugin: ""
networkPolicy: ""
nodePools:
- availabilityZones:
- ""
count: 0
enableAutoScaling: false
maxCount: 0
maxPods: 0
maxSurge: ""
minCount: 0
mode: ""
name: ""
nodeLabels: null
nodeTaints:
- ""
orchestratorVersion: ""
osDiskSizeGB: 0
osDiskType: ""
osType: ""
vmSize: ""
vnetSubnetID: ""
nodeResourceGroup: ""
outboundType: ""
podCidr: ""
privateCluster: false
privateDnsZone: ""
resourceGroup: ""
resourceLocation: ""
serviceCidr: ""
sshPublicKey: ""
subnet: ""
subscriptionID: ""
tags: null
tenantID: ""
userAssignedIdentity: ""
virtualNetwork: ""
virtualNetworkResourceGroup: ""
authorization:
adminTeams:
- ""
adminUsers:
- ""
binaryAuthorization:
evaluationMode: ""
description: ""
displayName: ""
loggingConfig:
componentConfig:
enableComponents:
- ""
monitoringConfig:
managedPrometheusConfig:
enabled: false
managedThanosConfig:
enabled: false
name: ""
oidcConfig:
issuerUri: ""
jwks: ""
owner: ""
Options
| Flag | Description |
|---|---|
--fleet string | Fleet to get the AKS cluster from |
-h, --help | Help for aks |
-n, --name string | Name of AKS cluster |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get aksoidcconnect
Get an AKS OIDC connect
Synopsis
The kosmos get aksoidcconnect command is used to retrieve details about a specified AKS OIDC connect.
kosmos get aksoidcconnect [flags]
Examples
kosmos get aksoidcconnect --name <aks-oidc-connect-name> --fleet <fleet-name>
kosmos get aksoidcconnect --name <aks-oidc-connect-name> # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
clientID: ""
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
name: ""
subscriptionID: ""
tenantID: ""
Options
| Flag | Description |
|---|---|
--fleet string | Fleet to get the AKS OIDC connect from |
-h, --help | Help for aksoidcconnect |
-n, --name string | Name of AKS OIDC connect |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get app
Get an app
Synopsis
The kosmos get app command is used to retrieve details about a specified app.
kosmos get app [flags]
Examples
kosmos get app --name <app-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
applicationRoles:
- description: ""
displayName: ""
role: ""
verbs:
- ""
clusters:
- ""
config:
annotations: null
bash:
clusterRole: ""
image: ""
podSecurityContext:
appArmorProfile:
localhostProfile: ""
type: ""
fsGroup: 0
fsGroupChangePolicy: ""
runAsGroup: 0
runAsNonRoot: false
runAsUser: 0
seLinuxChangePolicy: ""
seLinuxOptions:
level: ""
role: ""
type: ""
user: ""
seccompProfile:
localhostProfile: ""
type: ""
supplementalGroups:
- 0
supplementalGroupsPolicy: ""
sysctls:
- name: ""
value: ""
windowsOptions:
gmsaCredentialSpec: ""
gmsaCredentialSpecName: ""
hostProcess: false
runAsUserName: ""
script: ""
securityContext:
allowPrivilegeEscalation: false
appArmorProfile:
localhostProfile: ""
type: ""
capabilities:
add:
- ""
drop:
- ""
privileged: false
procMount: ""
readOnlyRootFilesystem: false
runAsGroup: 0
runAsNonRoot: false
runAsUser: 0
seLinuxOptions:
level: ""
role: ""
type: ""
user: ""
seccompProfile:
localhostProfile: ""
type: ""
windowsOptions:
gmsaCredentialSpec: ""
gmsaCredentialSpecName: ""
hostProcess: false
runAsUserName: ""
chart:
insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
repoURL: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
version: ""
manifests: ""
parameters: ""
values: ""
defaultNamespace: ""
description: ""
displayName: ""
helm:
insecure: false
name: ""
password: ""
repoUrl: ""
username: ""
values: ""
version: ""
icon: ""
manifests: ""
owner:
team: ""
user: ""
parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
readme: ""
recommendedApp:
- ""
streamContainer:
container: ""
selector:
matchExpressions:
- key: ""
operator: ""
values:
- ""
matchLabels: null
timeout: ""
versions:
- config:
annotations: null
bash:
clusterRole: ""
image: ""
podSecurityContext:
appArmorProfile:
localhostProfile: ""
type: ""
fsGroup: 0
fsGroupChangePolicy: ""
runAsGroup: 0
runAsNonRoot: false
runAsUser: 0
seLinuxChangePolicy: ""
seLinuxOptions:
level: ""
role: ""
type: ""
user: ""
seccompProfile:
localhostProfile: ""
type: ""
supplementalGroups:
- 0
supplementalGroupsPolicy: ""
sysctls:
- name: ""
value: ""
windowsOptions:
gmsaCredentialSpec: ""
gmsaCredentialSpecName: ""
hostProcess: false
runAsUserName: ""
script: ""
securityContext:
allowPrivilegeEscalation: false
appArmorProfile:
localhostProfile: ""
type: ""
capabilities:
add:
- ""
drop:
- ""
privileged: false
procMount: ""
readOnlyRootFilesystem: false
runAsGroup: 0
runAsNonRoot: false
runAsUser: 0
seLinuxOptions:
level: ""
role: ""
type: ""
user: ""
seccompProfile:
localhostProfile: ""
type: ""
windowsOptions:
gmsaCredentialSpec: ""
gmsaCredentialSpecName: ""
hostProcess: false
runAsUserName: ""
chart:
insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
repoURL: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
version: ""
manifests: ""
parameters: ""
values: ""
defaultNamespace: ""
icon: ""
parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
readme: ""
streamContainer:
container: ""
selector:
matchExpressions:
- key: ""
operator: ""
values:
- ""
matchLabels: null
timeout: ""
version: ""
wait: false
wait: false
Options
| Flag | Description |
|---|---|
-h, --help | Help for app |
-n, --name string | Name of app |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get applicationrole
Get an application role
Synopsis
The kosmos get applicationrole command is used to retrieve details about a specified application role.
kosmos get applicationrole [flags]
Examples
kosmos get applicationrole --name <application-role-name> --fleet <fleet-name>
kosmos get applicationrole --name <application-role-name> --devspace <devspace-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
description: ""
displayName: ""
teams:
- ""
users:
- ""
verbs:
- ""
Options
| Flag | Description |
|---|---|
--devspace string | devspace associated with application role |
--fleet string | fleet associated with application role |
-h, --help | Help for applicationrole |
--name string | Name of application role |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get clusteraccesskey
Get a network peer cluster access key
Synopsis
The kosmos get clusteraccesskey command is used to retrieve a network peer cluster token for a specified cluster. This token is used to establish secure communication between clusters.
kosmos get clusteraccesskey [flags]
Examples
kosmos get clusteraccesskey --name <cluster-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
config:
key: ""
secretName: ""
secretNamespace: ""
description: ""
displayName: ""
local: false
managementNamespace: ""
metrics:
replicas: 0
resources:
claims:
- name: ""
request: ""
limits: null
requests: null
retention: ""
storage:
size: ""
storageClass: ""
networkPeer: false
opencost:
replicas: 0
resources:
claims:
- name: ""
request: ""
limits: null
requests: null
owner:
team: ""
user: ""
unusable: false
Options
| Flag | Description |
|---|---|
-h, --help | Help for clusteraccesskey |
--name string | Name of cluster to retrieve access key for |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get clusterroletemplate
Get a cluster role template
Synopsis
The kosmos get clusterroletemplate command is used to retrieve details about a specified cluster role template.
kosmos get clusterroletemplate [flags]
Examples
kosmos get clusterroletemplate --name <cluster-role-template-name>
Options
| Flag | Description |
|---|---|
-h, --help | Help for clusterroletemplate |
-n, --name string | Name of cluster role template |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get currentuser
Get current Kosmos user
Synopsis
The kosmos get currentuser command is used to retrieve details about the currently logged in Kosmos user.
kosmos get currentuser [flags]
Examples
kosmos get currentuser
Options
| Flag | Description |
|---|---|
-h, --help | Help for currentuser |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get devspace
Get a devspace
Synopsis
The kosmos get devspace command is used to retrieve details about a specified devspace.
kosmos get devspace [flags]
Examples
kosmos get devspace --name <devspace-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- devSpaceTeams:
- ""
name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
allowedClusters:
- name: ""
allowedTemplates:
- group: ""
isDefault: false
kind: ""
name: ""
defaultDevSpaceRole: ""
description: ""
displayName: ""
members:
- clusterRole: ""
group: ""
kind: ""
name: ""
observability: {}
owner:
team: ""
user: ""
permissions:
- fleetRole: ""
teams:
- ""
users:
- ""
quotas:
devspace: null
user: null
users:
- ""
Options
| Flag | Description |
|---|---|
-h, --help | Help for devspace |
--name string | Name of devspace |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get devspaceallowedcluster
Get a devspace allowed cluster
Synopsis
The kosmos get devspaceallowedcluster command is used to retrieve details about a specified devspace allowed cluster.
kosmos get devspaceallowedcluster [flags]
Examples
kosmos get devspaceallowedcluster --name <devspace-allowed-cluster-name> --devspace <devspace-name>
kosmos get devspaceallowedcluster --name <devspace-allowed-cluster-name> # Requires default devspace value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec: {}
Options
| Flag | Description |
|---|---|
-h, --help | Help for devspaceallowedcluster |
-n, --name string | Name of devspace allowed cluster |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get devspaceclusteraccess
Get a devspace cluster access
Synopsis
The kosmos get devspaceclusteraccess command is used to retrieve details about a specified devspace cluster access.
kosmos get devspaceclusteraccess [flags]
Examples
kosmos get devspaceclusteraccess --name mydevspaceclusteraccess --devspace <devspace-name>
kosmos get devspaceclusteraccess --name mydevspaceclusteraccess # Requires default devspace value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusters:
- ""
description: ""
displayName: ""
localClusterAccessTemplate:
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
clusterRoles:
- name: ""
description: ""
displayName: ""
priority: 0
teams:
- ""
users:
- team: ""
user: ""
owner:
team: ""
user: ""
Options
| Flag | Description |
|---|---|
--devspace string | Devspace to get the devspace cluster access from |
-h, --help | Help for devspaceclusteraccess |
-n, --name string | Name of devspace cluster access |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get devspacerole
Get a devspace role
Synopsis
The kosmos get devspacerole command is used to retrieve details about a specified devspace role.
kosmos get devspacerole [flags]
Examples
kosmos get devspacerole --name <devspace-role-name> --devspace <devspace-name>
kosmos get devspacerole --name <devspace-role-name> # Requires default devspace value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
description: ""
displayName: ""
rules:
- resources:
- ""
verbs:
- ""
Options
| Flag | Description |
|---|---|
--devspace string | Devspace to get the devspace role from |
-h, --help | Help for devspacerole |
-n, --name string | Name of devspace role |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get devspacesecret
Get a devspace secret
Synopsis
The kosmos get devspacesecret command is used to retrieve details about a specified devspace secret.
kosmos get devspacesecret [flags]
Examples
kosmos get devspacesecret --name <devspace-secret-name> --devspace <devspace-name>
kosmos get devspacesecret --name <devspace-secret-name> # Requires default devspace value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
data: null
description: ""
displayName: ""
vaultRef:
mountPath: ""
secretPath: ""
Options
| Flag | Description |
|---|---|
--devspace string | Devspace to get the devspace secret from |
-h, --help | Help for devspacesecret |
-n, --name string | Name of devspace secret |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get devspaceteam
Get a devspace team
Synopsis
The kosmos get devspaceteam command is used to retrieve details about a specified devspace team.
kosmos get devspaceteam [flags]
Examples
kosmos get devspaceteam --name <devspace-team-name> --devspace <devspace-name>
kosmos get devspaceteam --name <devspace-team-name> # Requires default devspace value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusterRoles:
- name: ""
description: ""
displayName: ""
groups:
- ""
imagePullSecrets:
- apiGroup: ""
key: ""
kind: ""
secretName: ""
secretNamespace: ""
owner:
team: ""
user: ""
username: ""
users:
- ""
Options
| Flag | Description |
|---|---|
--devspace string | Devspace to get the devspace team from |
-h, --help | Help for devspaceteam |
-n, --name string | Name of devspace team |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get eks
Get an EKS cluster
Synopsis
The kosmos get eks command is used to retrieve details about a specified Elastic Kubernetes Service (EKS) cluster.
kosmos get eks [flags]
Examples
kosmos get eks --name <eks-cluster-name> --fleet <fleet-name>
kosmos get eks --name <eks-cluster-name> # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
authorization:
adminTeams:
- ""
adminUsers:
- ""
binaryAuthorization:
evaluationMode: ""
description: ""
displayName: ""
eksConfig:
bootstrapAccessEntry:
principalArn: ""
clusterRole: ""
deleteOnDetachment: false
displayName: ""
ebsCSIDriver: false
imported: false
kmsKey: ""
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
kosmosRoleArn: ""
kubernetesVersion: ""
loggingTypes:
- ""
nodeGroups:
- arm: false
desiredSize: 0
diskSize: 0
ec2SshKey: ""
gpu: false
imageId: ""
instanceType: ""
labels: null
launchTemplate:
id: ""
name: ""
version: 0
maxSize: 0
minSize: 0
nodeRole: ""
nodegroupName: ""
requestSpotInstances: false
resourceTags: null
spotInstanceTypes:
- ""
subnets:
- ""
tags: null
userData: ""
version: ""
privateAccess: false
publicAccess: false
publicAccessSources:
- ""
region: ""
secretsEncryption: false
securityGroups:
- ""
subnets:
- ""
tags: null
loggingConfig:
componentConfig:
enableComponents:
- ""
monitoringConfig:
managedPrometheusConfig:
enabled: false
managedThanosConfig:
enabled: false
name: ""
oidcConfig:
issuerUri: ""
jwks: ""
owner: ""
Options
| Flag | Description |
|---|---|
--fleet string | Fleet to get the EKS cluster from |
-h, --help | Help for eks |
-n, --name string | Name of EKS cluster |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get eksoidcconnect
Get an EKS OIDC connect
Synopsis
The kosmos get eksoidcconnect command is used to retrieve details about a specified EKS OIDC connect.
kosmos get eksoidcconnect [flags]
Examples
kosmos get eksoidcconnect --name <eks-oidc-connect-name> --fleet <fleet-name>
kosmos get eksoidcconnect --name <eks-oidc-connect-name> # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
kosmosRoleArn: ""
name: ""
region: ""
Options
| Flag | Description |
|---|---|
--fleet string | Fleet to get the EKS OIDC connect from |
-h, --help | Help for eksoidcconnect |
-n, --name string | Name of EKS OIDC connect |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get fleet
Get a fleet
Synopsis
The kosmos get fleet command is used to retrieve details about a specified fleet.
kosmos get fleet [flags]
Examples
kosmos get fleet --name <fleet-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- fleetTeams:
- ""
name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusterAccess:
- clusterRole: ""
teams:
- ""
users:
- ""
defaultFleetRole: ""
description: ""
displayName: ""
members:
- clusterRole: ""
kind: ""
name: ""
observability: {}
owner:
team: ""
user: ""
permissions:
- fleetRole: ""
teams:
- ""
users:
- ""
users:
- ""
Options
| Flag | Description |
|---|---|
-h, --help | Help for fleet |
--name string | Name of fleet |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get fleetclusteraccess
Get a fleet cluster access
Synopsis
The kosmos get fleetclusteraccess command is used to retrieve details about a specified fleet cluster access.
kosmos get fleetclusteraccess [flags]
Examples
kosmos get fleetclusteraccess --name <fleet-cluster-access-name> --fleet <fleet-name>
kosmos get fleetclusteraccess --name <fleet-cluster-access-name> # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusters:
- ""
description: ""
displayName: ""
localClusterAccessTemplate:
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
clusterRoles:
- name: ""
description: ""
displayName: ""
priority: 0
teams:
- ""
users:
- team: ""
user: ""
owner:
team: ""
user: ""
Options
| Flag | Description |
|---|---|
--fleet string | Fleet name to get the fleet cluster access from |
-h, --help | Help for fleetclusteraccess |
-n, --name string | Name of fleet cluster access |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get fleetclusterroletemplate
Get a fleet cluster role template
Synopsis
The kosmos get fleetclusterroletemplate command is used to retrieve details about a specified fleet cluster role template.
kosmos get fleetclusterroletemplate [flags]
Examples
kosmos get fleetclusterroletemplate --name <fleet-cluster-role-template-name> --fleet <fleet-name>kosmos get fleetclusterroletemplate --name <fleet-cluster-role-template-name> # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusterRoleTemplate:
aggregationRule:
clusterRoleSelectors:
- matchExpressions:
- key: ""
operator: ""
values:
- ""
matchLabels: null
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
rules:
- apiGroups:
- ""
nonResourceURLs:
- ""
resourceNames:
- ""
resources:
- ""
verbs:
- ""
clusters:
- ""
description: ""
displayName: ""
localClusterRoleTemplate:
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
clusterRoleTemplate:
aggregationRule:
clusterRoleSelectors:
- matchExpressions:
- key: ""
operator: ""
values:
- ""
matchLabels: null
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
rules:
- apiGroups:
- ""
nonResourceURLs:
- ""
resourceNames:
- ""
resources:
- ""
verbs:
- ""
description: ""
displayName: ""
management: false
owner:
team: ""
user: ""
Options
| Flag | Description |
|---|---|
--fleet string | Fleet owning this fleet cluster role template |
-h, --help | Help for fleetclusterroletemplate |
-n, --name string | Name of fleet cluster role template |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get fleetrole
Get a fleet role
Synopsis
The kosmos get fleetrole command is used to retrieve details about a specified fleet role.
kosmos get fleetrole [flags]
Examples
kosmos get fleetrole --name <fleet-role-name> --fleet <fleet-name>
kosmos get fleetrole --name <fleet-role-name> # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
description: ""
rules:
- resources:
- ""
verbs:
- ""
Options
| Flag | Description |
|---|---|
--fleet string | Fleet to get the fleet role from |
-h, --help | Help for fleetrole |
--name string | Name of fleet role |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get fleetsecret
Get a fleet secret
Synopsis
The kosmos get fleetsecret command is used to retrieve details about a specified fleet secret.
kosmos get fleetsecret [flags]
Examples
kosmos get fleetsecret --name <fleet-secret-name> --fleet <fleet-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
data: null
description: ""
displayName: ""
name: ""
namespace: ""
vaultRef:
mountPath: ""
secretPath: ""
Options
| Flag | Description |
|---|---|
--fleet string | Fleet to get the fleet secret from |
-h, --help | Help for fleetsecret |
-n, --name string | Name of fleet secret |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get fleetspacetemplate
Get a fleet space template
Synopsis
The kosmos get fleetspacetemplate command is used to retrieve details about a specified fleet space template.
kosmos get fleetspacetemplate [flags]
Examples
kosmos get fleetspacetemplate --name <fleet-space-template-name> --fleet <fleet-name>
kosmos get fleetspacetemplate --name <fleet-space-template-name> # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
description: ""
displayName: ""
owner:
team: ""
user: ""
parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
template:
apps:
- name: ""
namespace: ""
parameters: ""
releaseName: ""
version: ""
charts:
- insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
releaseName: ""
releaseNamespace: ""
repoURL: ""
timeout: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
values: ""
version: ""
wait: false
instanceTemplate:
metadata:
annotations: null
labels: null
metadata:
annotations: null
labels: null
objects: ""
versions:
- parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
template:
apps:
- name: ""
namespace: ""
parameters: ""
releaseName: ""
version: ""
charts:
- insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
releaseName: ""
releaseNamespace: ""
repoURL: ""
timeout: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
values: ""
version: ""
wait: false
instanceTemplate:
metadata:
annotations: null
labels: null
metadata:
annotations: null
labels: null
objects: ""
version: ""
Options
| Flag | Description |
|---|---|
--fleet string | Fleet name to get the fleet space template from |
-h, --help | Help for fleetspacetemplate |
-n, --name string | Name of fleet space template |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get fleetteam
Get a fleet team
Synopsis
The kosmos get fleetteam command is used to retrieve details about a specified fleet team.
kosmos get fleetteam [flags]
Examples
kosmos get fleetteam --name <fleet-team-name> --fleet <fleet-name>
kosmos get fleetteam --name <fleet-team-name> # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusterRoles:
- name: ""
description: ""
displayName: ""
groups:
- ""
imagePullSecrets:
- apiGroup: ""
key: ""
kind: ""
secretName: ""
secretNamespace: ""
owner:
team: ""
user: ""
username: ""
users:
- ""
Options
| Flag | Description |
|---|---|
--fleet string | Fleet to get the fleet team from |
-h, --help | Help for fleetteam |
--name string | Name of fleet team |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get genericcluster
Get a generic cluster
Synopsis
The kosmos get genericcluster command is used to retrieve details about a specified generic cluster.
kosmos get genericcluster [flags]
Examples
kosmos get genericcluster --name <generic-cluster-name> --fleet <fleet-name>
kosmos get genericcluster --name <generic-cluster-name> # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
authorization:
adminTeams:
- ""
adminUsers:
- ""
binaryAuthorization:
evaluationMode: ""
description: ""
displayName: ""
kubeConfig: ""
loggingConfig:
componentConfig:
enableComponents:
- ""
monitoringConfig:
managedPrometheusConfig:
enabled: false
managedThanosConfig:
enabled: false
name: ""
oidcConfig:
issuerUri: ""
jwks: ""
owner: ""
proxyConfig:
kubernetesSecret:
name: ""
namespace: ""
Options
| Flag | Description |
|---|---|
--fleet string | Fleet to get the generic cluster from |
-h, --help | Help for genericcluster |
-n, --name string | Name of generic cluster |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get gke
Get a GKE cluster
Synopsis
The kosmos get gke command is used to retrieve details about a specified Google Kubernetes Engine (GKE) cluster.
kosmos get gke [flags]
Examples
kosmos get gke --name <gke-cluster-name> --fleet <fleet-name>
kosmos get gke --name <gke-cluster-name> # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
authorization:
adminTeams:
- ""
adminUsers:
- ""
binaryAuthorization:
evaluationMode: ""
description: ""
displayName: ""
gkeConfig:
autopilotConfig:
enabled: false
clusterAddons:
horizontalPodAutoscaling: false
httpLoadBalancing: false
networkPolicyConfig: false
clusterIpv4Cidr: ""
clusterName: ""
deleteOnDetachment: false
description: ""
enableKubernetesAlpha: false
googleCredentialSecret: ""
imported: false
ipAllocationPolicy:
clusterIpv4CidrBlock: ""
clusterSecondaryRangeName: ""
createSubnetwork: false
nodeIpv4CidrBlock: ""
servicesIpv4CidrBlock: ""
servicesSecondaryRangeName: ""
subnetworkName: ""
useIpAliases: false
keyName: ""
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
kubernetesVersion: ""
labels: null
locations:
- ""
loggingService: ""
maintenanceWindow: ""
masterAuthorizedNetworks:
cidrBlocks:
- cidrBlock: ""
displayName: ""
enabled: false
monitoringService: ""
network: ""
networkPolicyEnabled: false
nodePools:
- autoscaling:
enabled: false
maxNodeCount: 0
minNodeCount: 0
config:
diskSizeGb: 0
diskType: ""
imageType: ""
labels: null
localSsdCount: 0
machineType: ""
oauthScopes:
- ""
preemptible: false
tags:
- ""
taints:
- effect: ""
key: ""
value: ""
initialNodeCount: 0
management:
autoRepair: false
autoUpgrade: false
maxPodsConstraint: 0
name: ""
version: ""
privateClusterConfig:
enablePrivateEndpoint: false
enablePrivateNodes: false
masterIpv4CidrBlock: ""
projectID: ""
projectNumber: ""
region: ""
serviceAccount: ""
subnetwork: ""
workloadIdentityPoolId: ""
workloadIdentityProviderId: ""
zone: ""
loggingConfig:
componentConfig:
enableComponents:
- ""
monitoringConfig:
managedPrometheusConfig:
enabled: false
managedThanosConfig:
enabled: false
name: ""
owner: ""
Options
| Flag | Description |
|---|---|
--fleet string | Fleet to get the GKE cluster from |
-h, --help | Help for gke |
-n, --name string | Name of GKE cluster |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get gkeoidcconnect
Get a GKE OIDC connect
Synopsis
The kosmos get gkeoidcconnect command is used to retrieve details about a specified GKE OIDC connect.
kosmos get gkeoidcconnect [flags]
Examples
kosmos get gkeoidcconnect --name <gke-oidc-connect-name> --fleet <fleet-name>
kosmos get gkeoidcconnect --name <gke-oidc-connect-name> # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
name: ""
projectNumber: ""
serviceAccount: ""
workloadIdentityPoolId: ""
workloadIdentityProviderId: ""
Options
| Flag | Description |
|---|---|
--fleet string | Fleet to get the GKE OIDC connect from |
-h, --help | Help for gkeoidcconnect |
-n, --name string | Name of GKE OIDC connect |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get mks
Get an MKS cluster
Synopsis
The kosmos get mks command is used to retrieve details about a specified Managed Kubernetes Service (MKS) cluster.
kosmos get mks [flags]
Examples
kosmos get mks --name <mks-cluster-name> --fleet <fleet-name>
kosmos get mks --name <mks-cluster-name> # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
authorization:
adminTeams:
- ""
adminUsers:
- ""
binaryAuthorization:
evaluationMode: ""
description: ""
displayName: ""
loggingConfig:
componentConfig:
enableComponents:
- ""
mksConfig:
clusterRole: ""
deleteOnDetachment: false
displayName: ""
ebsCSIDriver: false
imported: false
kmsKey: ""
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
kosmosRoleArn: ""
kubernetesVersion: ""
loggingTypes:
- ""
nodeGroups:
- desiredSize: 0
diskSize: 0
ec2SshKey: ""
gpu: false
imageId: ""
instanceType: ""
labels: null
launchTemplate:
id: ""
name: ""
version: 0
maxSize: 0
minSize: 0
nodeRole: ""
nodegroupName: ""
requestSpotInstances: false
resourceTags: null
spotInstanceTypes:
- ""
subnets:
- ""
tags: null
userData: ""
version: ""
privateAccess: false
publicAccess: false
publicAccessSources:
- ""
region: ""
secretsEncryption: false
securityGroups:
- ""
subnets:
- ""
tags: null
monitoringConfig:
managedPrometheusConfig:
enabled: false
managedThanosConfig:
enabled: false
name: ""
oidcConfig:
issuerUri: ""
jwks: ""
owner: ""
Options
| Flag | Description |
|---|---|
--fleet string | Fleet to get the MKS cluster from |
-h, --help | Help for mks |
-n, --name string | Name of MKS cluster |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get mksoidcconnect
Get an MKS OIDC connect
Synopsis
The kosmos get mksoidcconnect command is used to retrieve details about a specified MKS OIDC connect.
kosmos get mksoidcconnect [flags]
Examples
kosmos get mksoidcconnect --name <mks-oidc-connect-name> --fleet <fleet-name>
kosmos get mksoidcconnect --name <mks-oidc-connect-name> # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
kosmosRoleArn: ""
name: ""
region: ""
Options
| Flag | Description |
|---|---|
--fleet string | Fleet to get the MKS OIDC connect from |
-h, --help | Help for mksoidcconnect |
-n, --name string | Name of MKS OIDC connect |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get secret
Get key and value of a project / shared secret
Synopsis
The kosmos get secret command is used to retrieve the key and value of a specified project or shared secret. You can specify the secret name and optionally the project or namespace from which to retrieve it.
kosmos get secret [flags]
Examples
kosmos get secret --name <secret-name>
kosmos get secret --name <secret-name> --project <project-name>
Options
| Flag | Description |
|---|---|
-a, --all | Display all secret keys |
-h, --help | Help for secret |
--name string | Name of secret |
-n, --namespace string | The namespace in the Kosmos cluster to read the secret from. If omitted will use the namespace where Kosmos is installed in |
-p, --project string | The project to read the project secret from. (default "b") |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get team
Get a team
Synopsis
The kosmos get team command is used to retrieve details about a specified team.
kosmos get team [flags]
Examples
kosmos get team --name <team-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusterRoles:
- name: ""
description: ""
displayName: ""
groups:
- ""
imagePullSecrets:
- apiGroup: ""
key: ""
kind: ""
secretName: ""
secretNamespace: ""
owner:
team: ""
user: ""
username: ""
users:
- ""
Options
| Flag | Description |
|---|---|
-h, --help | Help for team |
-n, --name string | Name of team |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get vaultconfiguration
Get a vault configuration
Synopsis
The kosmos get vaultconfiguration command is used to retrieve details about a specified vault configuration.
kosmos get vaultconfiguration [flags]
Examples
kosmos get vaultconfiguration --name <vault-configuration-name> --devspace <devspace-name>
kosmos get vaultconfiguration --name <vault-configuration-name> --fleet <fleet-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
address: ""
auth:
token: ""
tokenSecretRef:
key: ""
name: ""
optional: false
enabled: false
syncInterval: ""
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
address: ""
auth:
token: ""
tokenSecretRef:
key: ""
name: ""
optional: false
enabled: false
syncInterval: ""
Options
| Flag | Description |
|---|---|
--devspace string | Devspace associated with vault configuration |
--fleet string | Fleet associated with vault configuration |
-h, --help | Help for vaultconfiguration |
--name string | Name of vault configuration |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get vcluster
Get a virtual cluster
Synopsis
The kosmos get vcluster command is used to retrieve details about a specified virtual cluster.
kosmos get vcluster [flags]
Examples
kosmos get vcluster --name <virtual-cluster-name> --devspace <devspace-name>
kosmos get vcluster --name <virtual-cluster-name> # Requires default devspace value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- devSpaceTeams:
- ""
name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusterRef:
cluster: ""
namespace: ""
virtualCluster: ""
deletionProtection: false
description: ""
displayName: ""
extraAccessRules:
- clusterRole: ""
devSpaceTeams:
- ""
teams:
- ""
users:
- ""
owner:
team: ""
user: ""
parameters: ""
sleepModeConfig:
deleteAfter: 0
forceSleep: false
forceSleepDuration: 0
ignoreActiveConnections: false
ignoreAll: false
ignoreGroups: ""
ignoreIngresses: false
ignoreResourceNames: ""
ignoreResourceVerbs: ""
ignoreResources: ""
ignoreUserAgents: ""
ignoreVClusters: false
ignoreVerbs: ""
sleepAfter: 0
sleepSchedule: ""
timezone: ""
wakeupSchedule: ""
templateRef:
name: ""
syncOnce: false
version: ""
Options
| Flag | Description |
|---|---|
--devspace string | DevSpace to get the virtual cluster from |
-h, --help | Help for vcluster |
-n, --name string | Name of virtual cluster |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos get vclustertemplate
Get a virtual cluster template
Synopsis
The kosmos get vclustertemplate command is used to retrieve details about a specified virtual cluster template.
kosmos get vclustertemplate [flags]
Examples
kosmos get vclustertemplate --name <virtual-cluster-template-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- devSpaceTeams:
- ""
name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
description: ""
displayName: ""
owner:
team: ""
user: ""
parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
template:
access:
defaultClusterRole: ""
rules:
- clusterRole: ""
devSpaceTeams:
- ""
teams:
- ""
users:
- ""
accessPoint:
ingress:
enabled: false
apps:
- name: ""
namespace: ""
parameters: ""
releaseName: ""
version: ""
charts:
- insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
releaseName: ""
releaseNamespace: ""
repoURL: ""
timeout: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
values: ""
version: ""
wait: false
forwardToken: false
helmRelease:
chart:
name: ""
password: ""
repo: ""
username: ""
version: ""
values: ""
instanceTemplate:
deletionProtection: false
metadata:
annotations: null
labels: null
sleepModeConfig:
deleteAfter: 0
forceSleep: false
forceSleepDuration: 0
ignoreActiveConnections: false
ignoreAll: false
ignoreGroups: ""
ignoreIngresses: false
ignoreResourceNames: ""
ignoreResourceVerbs: ""
ignoreResources: ""
ignoreUserAgents: ""
ignoreVClusters: false
ignoreVerbs: ""
sleepAfter: 0
sleepSchedule: ""
timezone: ""
wakeupSchedule: ""
metadata:
annotations: null
labels: null
objects: ""
pro:
enabled: false
spaceTemplate:
apps:
- name: ""
namespace: ""
parameters: ""
releaseName: ""
version: ""
charts:
- insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
releaseName: ""
releaseNamespace: ""
repoURL: ""
timeout: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
values: ""
version: ""
wait: false
metadata:
annotations: null
labels: null
objects: ""
versions:
- parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
template:
access:
defaultClusterRole: ""
rules:
- clusterRole: ""
devSpaceTeams:
- ""
teams:
- ""
users:
- ""
accessPoint:
ingress:
enabled: false
apps:
- name: ""
namespace: ""
parameters: ""
releaseName: ""
version: ""
charts:
- insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
releaseName: ""
releaseNamespace: ""
repoURL: ""
timeout: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
values: ""
version: ""
wait: false
forwardToken: false
helmRelease:
chart:
name: ""
password: ""
repo: ""
username: ""
version: ""
values: ""
instanceTemplate:
deletionProtection: false
metadata:
annotations: null
labels: null
sleepModeConfig:
deleteAfter: 0
forceSleep: false
forceSleepDuration: 0
ignoreActiveConnections: false
ignoreAll: false
ignoreGroups: ""
ignoreIngresses: false
ignoreResourceNames: ""
ignoreResourceVerbs: ""
ignoreResources: ""
ignoreUserAgents: ""
ignoreVClusters: false
ignoreVerbs: ""
sleepAfter: 0
sleepSchedule: ""
timezone: ""
wakeupSchedule: ""
metadata:
annotations: null
labels: null
objects: ""
pro:
enabled: false
spaceTemplate:
apps:
- name: ""
namespace: ""
parameters: ""
releaseName: ""
version: ""
charts:
- insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
releaseName: ""
releaseNamespace: ""
repoURL: ""
timeout: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
values: ""
version: ""
wait: false
metadata:
annotations: null
labels: null
objects: ""
version: ""
Options
| Flag | Description |
|---|---|
-h, --help | Help for vclustertemplate |
-n, --name string | Name of virtual cluster template |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos info
Display information on CLI version, OS, and architecture
Synopsis
The kosmos info command is used to display information on CLI version, OS, and architecture.
kosmos info [flags]
Examples
kosmos info
Options
| Flag | Description |
|---|---|
-h, --help | Help for info |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos install
Install Kosmos resources
Synopsis
The kosmos install command is used to install Kosmos resources.
Options
| Flag | Description |
|---|---|
-h, --help | Help for install |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos install app
Install an app from an app template
Synopsis
The kosmos install app command is used to install an app from an app template.
kosmos install app [flags]
Examples
kosmos install app
--name <app-name>
--version <app-version>
--parameter-file <path-to-parameter-file>
--release-name <release-name>
--target-cluster <target-cluster-name>
--fleet <fleet-name>
--devspace <devspace-name>
--target-namespace <target-namespace>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
applicationRoles:
- description: ""
displayName: ""
role: ""
verbs:
- ""
clusters:
- ""
config:
annotations: null
bash:
clusterRole: ""
image: ""
podSecurityContext:
appArmorProfile:
localhostProfile: ""
type: ""
fsGroup: 0
fsGroupChangePolicy: ""
runAsGroup: 0
runAsNonRoot: false
runAsUser: 0
seLinuxChangePolicy: ""
seLinuxOptions:
level: ""
role: ""
type: ""
user: ""
seccompProfile:
localhostProfile: ""
type: ""
supplementalGroups:
- 0
supplementalGroupsPolicy: ""
sysctls:
- name: ""
value: ""
windowsOptions:
gmsaCredentialSpec: ""
gmsaCredentialSpecName: ""
hostProcess: false
runAsUserName: ""
script: ""
securityContext:
allowPrivilegeEscalation: false
appArmorProfile:
localhostProfile: ""
type: ""
capabilities:
add:
- ""
drop:
- ""
privileged: false
procMount: ""
readOnlyRootFilesystem: false
runAsGroup: 0
runAsNonRoot: false
runAsUser: 0
seLinuxOptions:
level: ""
role: ""
type: ""
user: ""
seccompProfile:
localhostProfile: ""
type: ""
windowsOptions:
gmsaCredentialSpec: ""
gmsaCredentialSpecName: ""
hostProcess: false
runAsUserName: ""
chart:
insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
repoURL: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
version: ""
manifests: ""
parameters: ""
values: ""
defaultNamespace: ""
description: ""
displayName: ""
helm:
insecure: false
name: ""
password: ""
repoUrl: ""
username: ""
values: ""
version: ""
icon: ""
manifests: ""
owner:
team: ""
user: ""
parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
readme: ""
recommendedApp:
- ""
streamContainer:
container: ""
selector:
matchExpressions:
- key: ""
operator: ""
values:
- ""
matchLabels: null
timeout: ""
versions:
- config:
annotations: null
bash:
clusterRole: ""
image: ""
podSecurityContext:
appArmorProfile:
localhostProfile: ""
type: ""
fsGroup: 0
fsGroupChangePolicy: ""
runAsGroup: 0
runAsNonRoot: false
runAsUser: 0
seLinuxChangePolicy: ""
seLinuxOptions:
level: ""
role: ""
type: ""
user: ""
seccompProfile:
localhostProfile: ""
type: ""
supplementalGroups:
- 0
supplementalGroupsPolicy: ""
sysctls:
- name: ""
value: ""
windowsOptions:
gmsaCredentialSpec: ""
gmsaCredentialSpecName: ""
hostProcess: false
runAsUserName: ""
script: ""
securityContext:
allowPrivilegeEscalation: false
appArmorProfile:
localhostProfile: ""
type: ""
capabilities:
add:
- ""
drop:
- ""
privileged: false
procMount: ""
readOnlyRootFilesystem: false
runAsGroup: 0
runAsNonRoot: false
runAsUser: 0
seLinuxOptions:
level: ""
role: ""
type: ""
user: ""
seccompProfile:
localhostProfile: ""
type: ""
windowsOptions:
gmsaCredentialSpec: ""
gmsaCredentialSpecName: ""
hostProcess: false
runAsUserName: ""
chart:
insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
repoURL: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
version: ""
manifests: ""
parameters: ""
values: ""
defaultNamespace: ""
icon: ""
parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
readme: ""
streamContainer:
container: ""
selector:
matchExpressions:
- key: ""
operator: ""
values:
- ""
matchLabels: null
timeout: ""
version: ""
wait: false
wait: false
Options
| Flag | Description |
|---|---|
--devspace string | target devspace for the app |
--dry-run | Outputs the yaml that would be sent as the request payload |
--fleet string | target fleet for the app |
-h, --help | Help for app |
--name string | Name of the app |
--parameter-file string | parameter file(yaml) for the app |
--release-name string | release name |
--skeleton | Outputs skeleton YAML that can be used with the –file flag |
--target-cluster string | target cluster name |
--target-namespace string | Namespace. Default: kosmos-system |
--version string | Version of the app template |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos join
Join a cluster to Kosmos
Synopsis
The kosmos join command is used to connect a cluster to Kosmos management plane.
Options
| Flag | Description |
|---|---|
-h, --help | Help for join |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos join cluster
Join a cluster to Kosmos
Synopsis
The kosmos join cluster command is used to connect a cluster to Kosmos management plane.
kosmos join cluster [flags]
Examples
kosmos join cluster <cluster-name>
Options
| Flag | Description |
|---|---|
--agent-replicas int | Sets the number of agent replicas in Helm (default 2) |
--context string | The kube context to use for installation |
--display-name string | The display name to show in the UI for this cluster |
--fleet string | The fleet to get cluster details from |
--helm-chart-path string | The agent chart to deploy |
--helm-chart-version string | The agent chart version to deploy |
--helm-set stringArray | Extra helm values for the agent chart |
--helm-values stringArray | Extra helm values for the agent chart |
-h, --help | Help for cluster |
--insecure | If true, deploys the agent in insecure mode |
--namespace string | The namespace to generate the service account in. The namespace will be created if it does not exist (default "vcluster-platform") |
--previous-method | If true, will use the previous, non-experimental cluster enrollment feature |
--service-account string | The service account name to create (default "loft-admin") |
--wait | If true, will wait until the cluster is initialized |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list
List Kosmos resources
Synopsis
The kosmos list command is used to list resource configurations in Kosmos.
Options
| Flag | Description |
|---|---|
-h, --help | Help for list |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list accesskeys
List access keys you have access to
Synopsis
The kosmos list accesskeys command is used to list all access keys you have access to.
kosmos list accesskeys [flags]
Examples
kosmos list accesskeys --namespace <namespace>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
description: ""
disabled: false
displayName: ""
groups:
- ""
identity:
connector: ""
connectorData: AA==
email: ""
emailVerified: false
groups:
- ""
preferredUsername: ""
userId: ""
username: ""
identityRefresh: {}
key: ""
oidcLogin:
accessToken: AA==
idToken: AA==
lastRefresh: {}
refreshToken: AA==
oidcProvider:
clientId: ""
nonce: ""
redirectUri: ""
scopes: ""
parent: ""
scope:
allowLoftCli: false
clusters:
- cluster: ""
projects:
- project: ""
roles:
- projects:
- ""
role: ""
virtualClusters:
- ""
rules:
- cluster: ""
namespaces:
- ""
nonResourceURLs:
- ""
requestTargets:
- ""
resources:
- group: ""
resourceNames:
- ""
resources:
- ""
verbs:
- ""
virtualClusters:
- name: ""
namespace: ""
spaces:
- project: ""
space: ""
virtualClusters:
- project: ""
virtualCluster: ""
subject: ""
team: ""
ttl: 0
ttlAfterLastActivity: false
type: ""
user: ""
Options
| Flag | Description |
|---|---|
-h, --help | Help for accesskeys |
--namespace string | Namespace to get the access keys from |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list aks
List AKS clusters you have access to
Synopsis
The kosmos list aks command is used to list all Azure Kubernetes Service (AKS) clusters you have access to.
kosmos list aks [flags]
Examples
kosmos list aks --fleet <fleet-name>
kosmos list aks --all
kosmos list aks # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
aksConfig:
authBaseUrl: ""
authorizedIpRanges:
- ""
baseUrl: ""
clientID: ""
clusterName: ""
deleteOnDetachment: false
dnsPrefix: ""
dnsServiceIp: ""
httpApplicationRouting: false
imported: false
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
kubernetesVersion: ""
linuxAdminUsername: ""
loadBalancerSku: ""
logAnalyticsWorkspaceGroup: ""
logAnalyticsWorkspaceName: ""
managedIdentity: false
monitoring: false
networkPlugin: ""
networkPolicy: ""
nodePools:
- availabilityZones:
- ""
count: 0
enableAutoScaling: false
maxCount: 0
maxPods: 0
maxSurge: ""
minCount: 0
mode: ""
name: ""
nodeLabels: null
nodeTaints:
- ""
orchestratorVersion: ""
osDiskSizeGB: 0
osDiskType: ""
osType: ""
vmSize: ""
vnetSubnetID: ""
nodeResourceGroup: ""
outboundType: ""
podCidr: ""
privateCluster: false
privateDnsZone: ""
resourceGroup: ""
resourceLocation: ""
serviceCidr: ""
sshPublicKey: ""
subnet: ""
subscriptionID: ""
tags: null
tenantID: ""
userAssignedIdentity: ""
virtualNetwork: ""
virtualNetworkResourceGroup: ""
authorization:
adminTeams:
- ""
adminUsers:
- ""
binaryAuthorization:
evaluationMode: ""
description: ""
displayName: ""
loggingConfig:
componentConfig:
enableComponents:
- ""
monitoringConfig:
managedPrometheusConfig:
enabled: false
managedThanosConfig:
enabled: false
name: ""
oidcConfig:
issuerUri: ""
jwks: ""
owner: ""
Options
| Flag | Description |
|---|---|
-A, --all | Display AKS clusters from all fleets |
--fleet string | Fleet to get the AKS clusters from |
-h, --help | Help for aks |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list aksoidcconnects
List AKS OIDC connects
Synopsis
The kosmos list aksoidcconnects command is used to list all AKS OIDC connects.
kosmos list aksoidcconnects [flags]
Examples
kosmos list aksoidcconnects --fleet <fleet-name>
kosmos list aksoidcconnects --all
kosmos list aksoidcconnects # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
clientID: ""
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
name: ""
subscriptionID: ""
tenantID: ""
Options
| Flag | Description |
|---|---|
-A, --all | Display AKS OIDC connects from all fleets |
--fleet string | Fleet to get the AKS OIDC connects from |
-h, --help | Help for aksoidcconnects |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list applicationroles
List appplication roles associated with target
Synopsis
The kosmos list applicationroles command is used to list all appplication roles within a specified devspace or fleet.
kosmos list applicationroles [flags]
Examples
kosmos list applicationroles --fleet <fleet-name>
kosmos list applicationroles --devspace <devspace-name>
Options
| Flag | Description |
|---|---|
--devspace string | devspace associated with application role |
--fleet string | fleet associated with application role |
-h, --help | Help for applicationroles |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list apps
List apps
Synopsis
The kosmos list apps command is used to list all apps.
kosmos list apps [flags]
Examples
kosmos list apps
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
applicationRoles:
- description: ""
displayName: ""
role: ""
verbs:
- ""
clusters:
- ""
config:
annotations: null
bash:
clusterRole: ""
image: ""
podSecurityContext:
appArmorProfile:
localhostProfile: ""
type: ""
fsGroup: 0
fsGroupChangePolicy: ""
runAsGroup: 0
runAsNonRoot: false
runAsUser: 0
seLinuxChangePolicy: ""
seLinuxOptions:
level: ""
role: ""
type: ""
user: ""
seccompProfile:
localhostProfile: ""
type: ""
supplementalGroups:
- 0
supplementalGroupsPolicy: ""
sysctls:
- name: ""
value: ""
windowsOptions:
gmsaCredentialSpec: ""
gmsaCredentialSpecName: ""
hostProcess: false
runAsUserName: ""
script: ""
securityContext:
allowPrivilegeEscalation: false
appArmorProfile:
localhostProfile: ""
type: ""
capabilities:
add:
- ""
drop:
- ""
privileged: false
procMount: ""
readOnlyRootFilesystem: false
runAsGroup: 0
runAsNonRoot: false
runAsUser: 0
seLinuxOptions:
level: ""
role: ""
type: ""
user: ""
seccompProfile:
localhostProfile: ""
type: ""
windowsOptions:
gmsaCredentialSpec: ""
gmsaCredentialSpecName: ""
hostProcess: false
runAsUserName: ""
chart:
insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
repoURL: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
version: ""
manifests: ""
parameters: ""
values: ""
defaultNamespace: ""
description: ""
displayName: ""
helm:
insecure: false
name: ""
password: ""
repoUrl: ""
username: ""
values: ""
version: ""
icon: ""
manifests: ""
owner:
team: ""
user: ""
parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
readme: ""
recommendedApp:
- ""
streamContainer:
container: ""
selector:
matchExpressions:
- key: ""
operator: ""
values:
- ""
matchLabels: null
timeout: ""
versions:
- config:
annotations: null
bash:
clusterRole: ""
image: ""
podSecurityContext:
appArmorProfile:
localhostProfile: ""
type: ""
fsGroup: 0
fsGroupChangePolicy: ""
runAsGroup: 0
runAsNonRoot: false
runAsUser: 0
seLinuxChangePolicy: ""
seLinuxOptions:
level: ""
role: ""
type: ""
user: ""
seccompProfile:
localhostProfile: ""
type: ""
supplementalGroups:
- 0
supplementalGroupsPolicy: ""
sysctls:
- name: ""
value: ""
windowsOptions:
gmsaCredentialSpec: ""
gmsaCredentialSpecName: ""
hostProcess: false
runAsUserName: ""
script: ""
securityContext:
allowPrivilegeEscalation: false
appArmorProfile:
localhostProfile: ""
type: ""
capabilities:
add:
- ""
drop:
- ""
privileged: false
procMount: ""
readOnlyRootFilesystem: false
runAsGroup: 0
runAsNonRoot: false
runAsUser: 0
seLinuxOptions:
level: ""
role: ""
type: ""
user: ""
seccompProfile:
localhostProfile: ""
type: ""
windowsOptions:
gmsaCredentialSpec: ""
gmsaCredentialSpecName: ""
hostProcess: false
runAsUserName: ""
chart:
insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
repoURL: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
version: ""
manifests: ""
parameters: ""
values: ""
defaultNamespace: ""
icon: ""
parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
readme: ""
streamContainer:
container: ""
selector:
matchExpressions:
- key: ""
operator: ""
values:
- ""
matchLabels: null
timeout: ""
version: ""
wait: false
wait: false
Options
| Flag | Description |
|---|---|
-h, --help | Help for apps |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list clusterroletemplates
List cluster role templates
Synopsis
The kosmos list clusterroletemplates command is used to list all cluster role templates.
kosmos list clusterroletemplates [flags]
Examples
kosmos list clusterroletemplates
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
aksConfig:
authBaseUrl: ""
authorizedIpRanges:
- ""
baseUrl: ""
clientID: ""
clusterName: ""
deleteOnDetachment: false
dnsPrefix: ""
dnsServiceIp: ""
httpApplicationRouting: false
imported: false
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
kubernetesVersion: ""
linuxAdminUsername: ""
loadBalancerSku: ""
logAnalyticsWorkspaceGroup: ""
logAnalyticsWorkspaceName: ""
managedIdentity: false
monitoring: false
networkPlugin: ""
networkPolicy: ""
nodePools:
- availabilityZones:
- ""
count: 0
enableAutoScaling: false
maxCount: 0
maxPods: 0
maxSurge: ""
minCount: 0
mode: ""
name: ""
nodeLabels: null
nodeTaints:
- ""
orchestratorVersion: ""
osDiskSizeGB: 0
osDiskType: ""
osType: ""
vmSize: ""
vnetSubnetID: ""
nodeResourceGroup: ""
outboundType: ""
podCidr: ""
privateCluster: false
privateDnsZone: ""
resourceGroup: ""
resourceLocation: ""
serviceCidr: ""
sshPublicKey: ""
subnet: ""
subscriptionID: ""
tags: null
tenantID: ""
userAssignedIdentity: ""
virtualNetwork: ""
virtualNetworkResourceGroup: ""
authorization:
adminTeams:
- ""
adminUsers:
- ""
binaryAuthorization:
evaluationMode: ""
description: ""
displayName: ""
loggingConfig:
componentConfig:
enableComponents:
- ""
monitoringConfig:
managedPrometheusConfig:
enabled: false
managedThanosConfig:
enabled: false
name: ""
oidcConfig:
issuerUri: ""
jwks: ""
owner: ""
Options
| Flag | Description |
|---|---|
-h, --help | Help for clusterroletemplates |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list clusters
List clusters you have access to
Synopsis
The kosmos list clusters command is used to list all clusters you have access to within a specified fleet or across all fleets.
kosmos list clusters [flags]
Examples
kosmos list clusters --fleet <fleet-name>
kosmos list clusters --all
kosmos list clusters # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
description: ""
displayName: ""
distribution: ""
etag: ""
kubernetesVersion: ""
name: ""
workloadIdentityConfig:
identityProvider: ""
issuerUri: ""
workloadPool: ""
Options
| Flag | Description |
|---|---|
-A, --all | Display clusters from all fleets |
--distribution string | Distribution of cluster. Can be either generic, eks, mks, or gke |
--fleet string | Fleet to get the clusters from |
-h, --help | Help for clusters |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list devspaceallowedclusters
List devspace allowed clusters you have access to
Synopsis
The kosmos list devspaceallowedclusters command is used to list all devspace allowed clusters you have access to.
kosmos list devspaceallowedclusters [flags]
Examples
kosmos list devspaceallowedclusters
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec: {}
Options
| Flag | Description |
|---|---|
-h, --help | Help for devspaceallowedclusters |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list devspaceclusteraccesses
List devspace cluster accesses you have accesses to
Synopsis
The kosmos list devspaceclusteraccesses command is used to list all devspace cluster accesses you have accesses to within a specified devspace or across all devspaces.
kosmos list devspaceclusteraccesses [flags]
Examples
kosmos list devspaceclusteraccesses --devspace <devspace-name>
kosmos list devspaceclusteraccesses --all
kosmos list devspaceclusteraccesses # Requires default devspace value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusters:
- ""
description: ""
displayName: ""
localClusterAccessTemplate:
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
clusterRoles:
- name: ""
description: ""
displayName: ""
priority: 0
teams:
- ""
users:
- team: ""
user: ""
owner:
team: ""
user: ""
Options
| Flag | Description |
|---|---|
-A, --all | Display devspace cluster accesses from all devspaces |
--devspace string | Devspace to get the devspace cluster accesses from |
-h, --help | Help for devspaceclusteraccesses |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list devspaceroles
List devspace roles you have access to
Synopsis
The kosmos list devspaceroles command is used to list all devspace roles you have access to within a specified devspace or across all devspaces.
kosmos list devspaceroles [flags]
Examples
kosmos list devspaceroles --devspace <devspace-name>
kosmos list devspaceroles --all
kosmos list devspaceroles # Requires default devspace value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
description: ""
displayName: ""
rules:
- resources:
- ""
verbs:
- ""
Options
| Flag | Description |
|---|---|
-A, --all | Display devspace roles from all devspaces |
--devspace string | Devspace to get the devspace roles from |
-h, --help | Help for devspaceroles |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list devspaces
List devspaces you are a member of
Synopsis
The kosmos list devspaces command is used to list all devspaces you are a member of.
kosmos list devspaces [flags]
Examples
kosmos list devspaces
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- devSpaceTeams:
- ""
name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
allowedClusters:
- name: ""
allowedTemplates:
- group: ""
isDefault: false
kind: ""
name: ""
defaultDevSpaceRole: ""
description: ""
displayName: ""
members:
- clusterRole: ""
group: ""
kind: ""
name: ""
observability: {}
owner:
team: ""
user: ""
permissions:
- fleetRole: ""
teams:
- ""
users:
- ""
quotas:
devspace: null
user: null
users:
- ""
Options
| Flag | Description |
|---|---|
-h, --help | Help for devspaces |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list devspacesecrets
List devspace secrets you have access to
Synopsis
The kosmos list devspacesecrets command is used to list all devspace secrets you have access to within a specified devspace or across all devspaces.
kosmos list devspacesecrets [flags]
Examples
kosmos list devspacesecrets --devspace <devspace-name>
kosmos list devspacesecrets --all
kosmos list devspacesecretst # Requires default devspace value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
data: null
description: ""
displayName: ""
vaultRef:
mountPath: ""
secretPath: ""
Options
| Flag | Description |
|---|---|
-A, --all | Display devspace secrets from all devspaces |
--devspace string | Devspace to get the devspace secrets from |
-h, --help | Help for devspacesecrets |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list devspaceteams
List devspace teams you have access to
Synopsis
The kosmos list devspaceteams command is used to list all devspace teams you have access to within a specified devspace or across all devspaces.
kosmos list devspaceteams [flags]
Examples
kosmos list devspaceteams --devspace <devspace-name>
kosmos list devspaceteams --all
kosmos list devspaceteams # Requires default devspace value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusterRoles:
- name: ""
description: ""
displayName: ""
groups:
- ""
imagePullSecrets:
- apiGroup: ""
key: ""
kind: ""
secretName: ""
secretNamespace: ""
owner:
team: ""
user: ""
username: ""
users:
- ""
Options
| Flag | Description |
|---|---|
-A, --all | Display devspace teams from all devspaces |
--devspace string | Devspace to get the devspace teams from |
-h, --help | Help for devspaceteams |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list eks
List EKS clusters you have access to
Synopsis
The kosmos list eks command is used to list all Elastic Kubernetes Service (EKS) clusters you have access to within a specified fleet or across all fleets.
kosmos list eks [flags]
Examples
kosmos list eks --fleet <fleet-name>
kosmos list eks --all
kosmos list eks # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
authorization:
adminTeams:
- ""
adminUsers:
- ""
binaryAuthorization:
evaluationMode: ""
description: ""
displayName: ""
eksConfig:
bootstrapAccessEntry:
principalArn: ""
clusterRole: ""
deleteOnDetachment: false
displayName: ""
ebsCSIDriver: false
imported: false
kmsKey: ""
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
kosmosRoleArn: ""
kubernetesVersion: ""
loggingTypes:
- ""
nodeGroups:
- arm: false
desiredSize: 0
diskSize: 0
ec2SshKey: ""
gpu: false
imageId: ""
instanceType: ""
labels: null
launchTemplate:
id: ""
name: ""
version: 0
maxSize: 0
minSize: 0
nodeRole: ""
nodegroupName: ""
requestSpotInstances: false
resourceTags: null
spotInstanceTypes:
- ""
subnets:
- ""
tags: null
userData: ""
version: ""
privateAccess: false
publicAccess: false
publicAccessSources:
- ""
region: ""
secretsEncryption: false
securityGroups:
- ""
subnets:
- ""
tags: null
loggingConfig:
componentConfig:
enableComponents:
- ""
monitoringConfig:
managedPrometheusConfig:
enabled: false
managedThanosConfig:
enabled: false
name: ""
oidcConfig:
issuerUri: ""
jwks: ""
owner: ""
Options
| Flag | Description |
|---|---|
-A, --all | Display EKS clusters from all fleets |
--fleet string | Fleet to get the EKS clusters from |
-h, --help | Help for eks |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list eksoidcconnects
List EKS OIDC connects
Synopsis
The kosmos list eksoidcconnects command is used to list all EKS OIDC connects within a specified fleet or across all fleets.
kosmos list eksoidcconnects [flags]
Examples
kosmos list eksoidcconnects --fleet <fleet-name>
kosmos list eksoidcconnects --all
kosmos list eksoidcconnects # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
kosmosRoleArn: ""
name: ""
region: ""
Options
| Flag | Description |
|---|---|
-A, --all | Display EKS OIDC connects from all fleets |
--fleet string | Fleet to get the EKS OIDC connects from |
-h, --help | Help for eksoidcconnects |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list fleetclusteraccesses
List fleet cluster accesses
Synopsis
The kosmos list fleetclusteraccesses command is used to list all fleet cluster accesses within a specified fleet or across all fleets.
kosmos list fleetclusteraccesses [flags]
Examples
kosmos list fleetclusteraccesses --fleet <fleet-name>
kosmos list fleetclusteraccesses --all
kosmos list fleetclusteraccesses # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusters:
- ""
description: ""
displayName: ""
localClusterAccessTemplate:
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
clusterRoles:
- name: ""
description: ""
displayName: ""
priority: 0
teams:
- ""
users:
- team: ""
user: ""
owner:
team: ""
user: ""
Options
| Flag | Description |
|---|---|
-A, --all | Display fleet cluster accesses from all fleets |
--fleet string | Fleet to list the fleet cluster accesses from |
-h, --help | Help for fleetclusteraccesses |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list fleetclusterroletemplates
List fleet cluster role templates
Synopsis
The kosmos list fleetclusterroletemplates command is used to list all fleet cluster role templates within a specified fleet.
kosmos list fleetclusterroletemplates [flags]
Examples
kosmos list fleetclusterroletemplates
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusterRoleTemplate:
aggregationRule:
clusterRoleSelectors:
- matchExpressions:
- key: ""
operator: ""
values:
- ""
matchLabels: null
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
rules:
- apiGroups:
- ""
nonResourceURLs:
- ""
resourceNames:
- ""
resources:
- ""
verbs:
- ""
clusters:
- ""
description: ""
displayName: ""
localClusterRoleTemplate:
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
clusterRoleTemplate:
aggregationRule:
clusterRoleSelectors:
- matchExpressions:
- key: ""
operator: ""
values:
- ""
matchLabels: null
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
rules:
- apiGroups:
- ""
nonResourceURLs:
- ""
resourceNames:
- ""
resources:
- ""
verbs:
- ""
description: ""
displayName: ""
management: false
owner:
team: ""
user: ""
Options
| Flag | Description |
|---|---|
--fleet string | Fleet to list fleet cluster role templates from |
-h, --help | Help for fleetclusterroletemplates |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list fleetroles
List fleet roles you have access to
Synopsis
The kosmos list fleetroles command is used to list all fleet roles within a specified fleet or across all fleets.
kosmos list fleetroles [flags]
Examples
kosmos list fleetroles --fleet <fleet-name>
kosmos list fleetroles --all
kosmos list fleetroles # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
description: ""
rules:
- resources:
- ""
verbs:
- ""
Options
| Flag | Description |
|---|---|
-A, --all | Display fleet roles from all fleets |
--fleet string | Fleet to list the fleet roles from |
-h, --help | Help for fleetroles |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list fleets
List fleets you have access to
Synopsis
The kosmos list fleets command is used to list all fleets you have access to.
kosmos list fleets [flags]
Examples
kosmos list fleets
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- fleetTeams:
- ""
name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusterAccess:
- clusterRole: ""
teams:
- ""
users:
- ""
defaultFleetRole: ""
description: ""
displayName: ""
members:
- clusterRole: ""
kind: ""
name: ""
observability: {}
owner:
team: ""
user: ""
permissions:
- fleetRole: ""
teams:
- ""
users:
- ""
users:
- ""
Options
| Flag | Description |
|---|---|
-h, --help | Help for fleets |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list fleetsecrets
List fleet secrets you have access to
Synopsis
The kosmos list fleetsecrets command is used to list all fleet secrets within a specified fleet or across all fleets.
kosmos list fleetsecrets [flags]
Examples
kosmos list fleetsecrets --fleet <fleet-name>
kosmos list fleetsecrets --all
kosmos list fleetsecrets # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
data: null
description: ""
displayName: ""
name: ""
namespace: ""
vaultRef:
mountPath: ""
secretPath: ""
Options
| Flag | Description |
|---|---|
-A, --all | Display fleet secrets from all fleets |
--fleet string | Fleet to get the fleet secrets from |
-h, --help | Help for fleetsecrets |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list fleetspacetemplates
List fleet space templates
Synopsis
The kosmos list fleetspacetemplates command is used to list all fleet space templates within a specified fleet.
kosmos list fleetspacetemplates [flags]
Examples
kosmos list fleetspacetemplates --fleet <fleet-name>
kosmos list fleetspacetemplates --all
kosmos list fleetspacetemplates # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
description: ""
displayName: ""
owner:
team: ""
user: ""
parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
template:
apps:
- name: ""
namespace: ""
parameters: ""
releaseName: ""
version: ""
charts:
- insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
releaseName: ""
releaseNamespace: ""
repoURL: ""
timeout: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
values: ""
version: ""
wait: false
instanceTemplate:
metadata:
annotations: null
labels: null
metadata:
annotations: null
labels: null
objects: ""
versions:
- parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
template:
apps:
- name: ""
namespace: ""
parameters: ""
releaseName: ""
version: ""
charts:
- insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
releaseName: ""
releaseNamespace: ""
repoURL: ""
timeout: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
values: ""
version: ""
wait: false
instanceTemplate:
metadata:
annotations: null
labels: null
metadata:
annotations: null
labels: null
objects: ""
version: ""
Options
| Flag | Description |
|---|---|
--fleet string | Fleet to list the fleet space templates from |
-h, --help | Help for fleetspacetemplates |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list fleetteams
List fleet teams you have access to
Synopsis
The kosmos list fleetteams command is used to list all fleet teams within a specified fleet or across all fleets.
kosmos list fleetteams [flags]
Examples
kosmos list fleetteams --fleet <fleet-name>
kosmos list fleetteams --all
kosmos list fleetteams # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusterRoles:
- name: ""
description: ""
displayName: ""
groups:
- ""
imagePullSecrets:
- apiGroup: ""
key: ""
kind: ""
secretName: ""
secretNamespace: ""
owner:
team: ""
user: ""
username: ""
users:
- ""
Options
| Flag | Description |
|---|---|
-A, --all | Display fleet teams from all fleets |
--fleet string | Fleet to get the fleet teams from |
-h, --help | Help for fleetteams |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list genericclusters
List generic clusters you have access to
Synopsis
The kosmos list genericclusters command is used to list all generic clusters you have access to within a specified fleet or across all fleets.
kosmos list genericclusters [flags]
Examples
kosmos list genericclusters --fleet <fleet-name>
kosmos list genericclusters --all
kosmos list genericclusters # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
authorization:
adminTeams:
- ""
adminUsers:
- ""
binaryAuthorization:
evaluationMode: ""
description: ""
displayName: ""
kubeConfig: ""
loggingConfig:
componentConfig:
enableComponents:
- ""
monitoringConfig:
managedPrometheusConfig:
enabled: false
managedThanosConfig:
enabled: false
name: ""
oidcConfig:
issuerUri: ""
jwks: ""
owner: ""
proxyConfig:
kubernetesSecret:
name: ""
namespace: ""
Options
| Flag | Description |
|---|---|
-A, --all | Display generic clusters from all fleets |
--fleet string | Fleet to get the generic clusters from |
-h, --help | Help for genericclusters |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list gke
List GKE clusters you have access to
Synopsis
The kosmos list gke command is used to list all Google Kubernetes Engine (GKE) clusters you have access to within a specified fleet or across all fleets.
kosmos list gke [flags]
Examples
kosmos list gke --fleet <fleet-name>
kosmos list gke --all
kosmos list gke # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
authorization:
adminTeams:
- ""
adminUsers:
- ""
binaryAuthorization:
evaluationMode: ""
description: ""
displayName: ""
gkeConfig:
autopilotConfig:
enabled: false
clusterAddons:
horizontalPodAutoscaling: false
httpLoadBalancing: false
networkPolicyConfig: false
clusterIpv4Cidr: ""
clusterName: ""
deleteOnDetachment: false
description: ""
enableKubernetesAlpha: false
googleCredentialSecret: ""
imported: false
ipAllocationPolicy:
clusterIpv4CidrBlock: ""
clusterSecondaryRangeName: ""
createSubnetwork: false
nodeIpv4CidrBlock: ""
servicesIpv4CidrBlock: ""
servicesSecondaryRangeName: ""
subnetworkName: ""
useIpAliases: false
keyName: ""
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
kubernetesVersion: ""
labels: null
locations:
- ""
loggingService: ""
maintenanceWindow: ""
masterAuthorizedNetworks:
cidrBlocks:
- cidrBlock: ""
displayName: ""
enabled: false
monitoringService: ""
network: ""
networkPolicyEnabled: false
nodePools:
- autoscaling:
enabled: false
maxNodeCount: 0
minNodeCount: 0
config:
diskSizeGb: 0
diskType: ""
imageType: ""
labels: null
localSsdCount: 0
machineType: ""
oauthScopes:
- ""
preemptible: false
tags:
- ""
taints:
- effect: ""
key: ""
value: ""
initialNodeCount: 0
management:
autoRepair: false
autoUpgrade: false
maxPodsConstraint: 0
name: ""
version: ""
privateClusterConfig:
enablePrivateEndpoint: false
enablePrivateNodes: false
masterIpv4CidrBlock: ""
projectID: ""
projectNumber: ""
region: ""
serviceAccount: ""
subnetwork: ""
workloadIdentityPoolId: ""
workloadIdentityProviderId: ""
zone: ""
loggingConfig:
componentConfig:
enableComponents:
- ""
monitoringConfig:
managedPrometheusConfig:
enabled: false
managedThanosConfig:
enabled: false
name: ""
owner: ""
Options
| Flag | Description |
|---|---|
-A, --all | Display GKE clusters from all fleets |
--fleet string | Fleet to get the GKE clusters from |
-h, --help | Help for gke |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list gkeoidcconnects
List GKE OIDC connects
Synopsis
The kosmos list gkeoidcconnects command is used to list all GKE OIDC connects within a specified fleet or across all fleets.
kosmos list gkeoidcconnects [flags]
Examples
kosmos list gkeoidcconnects --fleet <fleet-name>
kosmos list gkeoidcconnects --all
kosmos list gkeoidcconnects # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
name: ""
projectNumber: ""
serviceAccount: ""
workloadIdentityPoolId: ""
workloadIdentityProviderId: ""
Options
| Flag | Description |
|---|---|
-A, --all | Display GKE OIDC connects from all fleets |
--fleet string | Fleet to get the GKE OIDC connects from |
-h, --help | Help for gkeoidcconnects |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list hostclusters
List host clusters
Synopsis
The kosmos list hostclusters command is used to list all host clusters.
kosmos list hostclusters [flags]
Examples
kosmos list hostclusters
Options
| Flag | Description |
|---|---|
-h, --help | Help for hostclusters |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list mks
List MKS clusters you have access to
Synopsis
The kosmos list mks command is used to list all Managed Kubernetes Service (MKS) clusters you have access to within a specified fleet or across all fleets.
kosmos list mks [flags]
Examples
kosmos list mks --fleet <fleet-name>
kosmos list mks --all
kosmos list mks # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
authorization:
adminTeams:
- ""
adminUsers:
- ""
binaryAuthorization:
evaluationMode: ""
description: ""
displayName: ""
loggingConfig:
componentConfig:
enableComponents:
- ""
mksConfig:
clusterRole: ""
deleteOnDetachment: false
displayName: ""
ebsCSIDriver: false
imported: false
kmsKey: ""
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
kosmosRoleArn: ""
kubernetesVersion: ""
loggingTypes:
- ""
nodeGroups:
- desiredSize: 0
diskSize: 0
ec2SshKey: ""
gpu: false
imageId: ""
instanceType: ""
labels: null
launchTemplate:
id: ""
name: ""
version: 0
maxSize: 0
minSize: 0
nodeRole: ""
nodegroupName: ""
requestSpotInstances: false
resourceTags: null
spotInstanceTypes:
- ""
subnets:
- ""
tags: null
userData: ""
version: ""
privateAccess: false
publicAccess: false
publicAccessSources:
- ""
region: ""
secretsEncryption: false
securityGroups:
- ""
subnets:
- ""
tags: null
monitoringConfig:
managedPrometheusConfig:
enabled: false
managedThanosConfig:
enabled: false
name: ""
oidcConfig:
issuerUri: ""
jwks: ""
owner: ""
Options
| Flag | Description |
|---|---|
-A, --all | Display MKS clusters from all fleets |
--fleet string | Fleet to get the MKS clusters from |
-h, --help | Help for mks |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list mksoidcconnects
List MKS OIDC connects
Synopsis
The kosmos list mksoidcconnects command is used to list all MKS OIDC connects within a specified fleet or across all fleets.
kosmos list mksoidcconnects [flags]
Examples
kosmos list mksoidcconnects --fleet <fleet-name>
kosmos list mksoidcconnects --all
kosmos list mksoidcconnects # Requires default fleet value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
kosmosRoleArn: ""
name: ""
region: ""
Options
| Flag | Description |
|---|---|
-A, --all | Display MKS OIDC connects from all fleets |
--fleet string | Fleet to get the MKS OIDC connects from |
-h, --help | Help for mksoidcconnects |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list quotas
List quotas for a particular devspace
Synopsis
The kosmos list quotas command is used to list all quotas for a particular devspace.
kosmos list quotas [flags]
Examples
kosmos list quotas --devspace <devspace-name>
Options
| Flag | Description |
|---|---|
--devspace string | Devspace to get the quotas from |
-h, --help | Help for quotas |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list secrets
List shared secrets you have access to
Synopsis
The kosmos list secrets command is used to list all shared secrets you have access to.
kosmos list secrets [flags]
Examples
kosmos list secrets
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
data: null
description: ""
displayName: ""
owner:
team: ""
user: ""
Options
| Flag | Description |
|---|---|
-a, --all | Display global and project secrets. May be used with the –project flag to display global secrets and a subset of project secrets |
--all-projects | Display project secrets for all projects. |
-h, --help | Help for secrets |
-n, --namespace string | The namespace in the Kosmos cluster to read global secrets from. If omitted will query all accessible global secrets |
-p, --project stringArray | The project(s) to read project secrets from. If omitted will list global secrets |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list teams
List teams you are member of
Synopsis
The kosmos list teams command is used to list all teams you are member of.
kosmos list teams [flags]
Examples
kosmos list teams
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusterRoles:
- name: ""
description: ""
displayName: ""
groups:
- ""
imagePullSecrets:
- apiGroup: ""
key: ""
kind: ""
secretName: ""
secretNamespace: ""
owner:
team: ""
user: ""
username: ""
users:
- ""
Options
| Flag | Description |
|---|---|
-h, --help | Help for teams |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list vaultconfigurations
List vault configurations you have access to
Synopsis
The kosmos list vaultconfigurations command is used to list all vault configurations you have access to.
kosmos list vaultconfigurations [flags]
Examples
kosmos list vaultconfigurations
kosmos list vaultconfigurations --all
kosmos list vaultconfigurations --devspace <devspace-name>
kosmos list vaultconfigurations --fleet <fleet-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
address: ""
auth:
token: ""
tokenSecretRef:
key: ""
name: ""
optional: false
enabled: false
syncInterval: ""
Options
| Flag | Description |
|---|---|
-A, --all | display vault configurations from all devspaces |
--devspace string | devspace associated with vault configuration |
--fleet string | fleet associated with vault configuration |
-h, --help | Help for vaultconfigurations |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list vclusters
List virtual clusters you have access to
Synopsis
The kosmos list vclusters command is used to list all virtual clusters you have access to within a specified devspace or across all devspaces.
kosmos list vclusters [flags]
Examples
kosmos list vclusters --devspace <devspace-name>
kosmos list vclusters --all
kosmos list vclusters # Requires default devspace value to be set
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- devSpaceTeams:
- ""
name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusterRef:
cluster: ""
namespace: ""
virtualCluster: ""
deletionProtection: false
description: ""
displayName: ""
extraAccessRules:
- clusterRole: ""
devSpaceTeams:
- ""
teams:
- ""
users:
- ""
owner:
team: ""
user: ""
parameters: ""
sleepModeConfig:
deleteAfter: 0
forceSleep: false
forceSleepDuration: 0
ignoreActiveConnections: false
ignoreAll: false
ignoreGroups: ""
ignoreIngresses: false
ignoreResourceNames: ""
ignoreResourceVerbs: ""
ignoreResources: ""
ignoreUserAgents: ""
ignoreVClusters: false
ignoreVerbs: ""
sleepAfter: 0
sleepSchedule: ""
timezone: ""
wakeupSchedule: ""
templateRef:
name: ""
syncOnce: false
version: ""
Options
| Flag | Description |
|---|---|
-A, --all | Display virtual clusters from all devspaces |
--devspace string | Devspace to get the virtual cluster from |
-h, --help | Help for vclusters |
--show-legacy | If true, will always show the legacy virtual clusters as well |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos list vclustertemplates
List virtual cluster templates
Synopsis
The kosmos list vclustertemplates command is used to list all virtual cluster templates.
kosmos list vclustertemplates [flags]
Examples
kosmos list vclustertemplates
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- devSpaceTeams:
- ""
name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
description: ""
displayName: ""
owner:
team: ""
user: ""
parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
template:
access:
defaultClusterRole: ""
rules:
- clusterRole: ""
devSpaceTeams:
- ""
teams:
- ""
users:
- ""
accessPoint:
ingress:
enabled: false
apps:
- name: ""
namespace: ""
parameters: ""
releaseName: ""
version: ""
charts:
- insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
releaseName: ""
releaseNamespace: ""
repoURL: ""
timeout: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
values: ""
version: ""
wait: false
forwardToken: false
helmRelease:
chart:
name: ""
password: ""
repo: ""
username: ""
version: ""
values: ""
instanceTemplate:
deletionProtection: false
metadata:
annotations: null
labels: null
sleepModeConfig:
deleteAfter: 0
forceSleep: false
forceSleepDuration: 0
ignoreActiveConnections: false
ignoreAll: false
ignoreGroups: ""
ignoreIngresses: false
ignoreResourceNames: ""
ignoreResourceVerbs: ""
ignoreResources: ""
ignoreUserAgents: ""
ignoreVClusters: false
ignoreVerbs: ""
sleepAfter: 0
sleepSchedule: ""
timezone: ""
wakeupSchedule: ""
metadata:
annotations: null
labels: null
objects: ""
pro:
enabled: false
spaceTemplate:
apps:
- name: ""
namespace: ""
parameters: ""
releaseName: ""
version: ""
charts:
- insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
releaseName: ""
releaseNamespace: ""
repoURL: ""
timeout: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
values: ""
version: ""
wait: false
metadata:
annotations: null
labels: null
objects: ""
versions:
- parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
template:
access:
defaultClusterRole: ""
rules:
- clusterRole: ""
devSpaceTeams:
- ""
teams:
- ""
users:
- ""
accessPoint:
ingress:
enabled: false
apps:
- name: ""
namespace: ""
parameters: ""
releaseName: ""
version: ""
charts:
- insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
releaseName: ""
releaseNamespace: ""
repoURL: ""
timeout: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
values: ""
version: ""
wait: false
forwardToken: false
helmRelease:
chart:
name: ""
password: ""
repo: ""
username: ""
version: ""
values: ""
instanceTemplate:
deletionProtection: false
metadata:
annotations: null
labels: null
sleepModeConfig:
deleteAfter: 0
forceSleep: false
forceSleepDuration: 0
ignoreActiveConnections: false
ignoreAll: false
ignoreGroups: ""
ignoreIngresses: false
ignoreResourceNames: ""
ignoreResourceVerbs: ""
ignoreResources: ""
ignoreUserAgents: ""
ignoreVClusters: false
ignoreVerbs: ""
sleepAfter: 0
sleepSchedule: ""
timezone: ""
wakeupSchedule: ""
metadata:
annotations: null
labels: null
objects: ""
pro:
enabled: false
spaceTemplate:
apps:
- name: ""
namespace: ""
parameters: ""
releaseName: ""
version: ""
charts:
- insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
releaseName: ""
releaseNamespace: ""
repoURL: ""
timeout: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
values: ""
version: ""
wait: false
metadata:
annotations: null
labels: null
objects: ""
version: ""
Options
| Flag | Description |
|---|---|
-h, --help | Help for vclustertemplates |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos login
Log in to Kosmos
Synopsis
The kosmos login command is used to log in to Kosmos.
kosmos login [KOSMOS_HOST] [flags]
Examples
kosmos login https://console.kosmos.spcplatform.com
kosmos login https://console.kosmos.spcplatform.com --access-key <access-key>
Options
| Flag | Description |
|---|---|
--access-key string | The access key to use |
--docker-login | If true, will log into the docker image registries the user has image pull secrets for. (Default true) |
-h, --help | Help for login |
--insecure | Allow login into an insecure Kosmos instance. (Default true) |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos logout
Log out of Kosmos
Synopsis
The kosmos logout command is used to log out of Kosmos.
kosmos logout [flags]
Examples
kosmos logout
Options
| Flag | Description |
|---|---|
-h, --help | Help for logout |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos reset
Reset configuration
Synopsis
The kosmos reset command is used to reset configuration of Kosmos to its default state. It can be used if you want to clear all current settings and restore the default configuration.
Options
| Flag | Description |
|---|---|
-h, --help | Help for reset |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos reset password
Reset password of a user
Synopsis
The kosmos reset password command is used to reset the password for a specified user. If the user doesn’t exist, you can optionally create them. Additionally, if the user has no existing password, you can force a password reset to set one.
kosmos reset password [flags]
Examples
kosmos reset password
kosmos reset password --user <user-name>
Options
| Flag | Description |
|---|---|
--create | Creates the user if it does not exist |
--force | If user had no password will create one |
-h, --help | Help for password |
--password string | The new password to use |
--user string | The name of the user to reset the password (default "admin") |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos set
Configure Kosmos environment settings
Synopsis
The kosmos set command is used to set configuration parameters that are relevant to your Kosmos instance.
Options
| Flag | Description |
|---|---|
-h, --help | Help for set |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos set secret
Set key and value of a project / shared secret
Synopsis
The kosmos set secret command is used to set or update the key-value pair of a project or shared secret within Kosmos.
kosmos set secret [flags]
Examples
kosmos set secret --file <path-to-secret-key-file> --value <value>
kosmos set secret --file <path-to-secret-key-file> --value <value> --project <project-name>
Options
| Flag | Description |
|---|---|
-f, --file string | Path to file containing secret key |
-h, --help | Help for secret |
-n, --namespace string | Namespace in Kosmos cluster to create secret in. If omitted will use the namespace where Kosmos is installed. |
-p, --project string | Project to create secret in. (default "b") |
-v, --value string | Value to set for secret key |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos share
Share cluster resources
Synopsis
The kosmos share command is used to share resources such as projects, secrets, or other relevant assets with different teams, users, or groups within the Kosmos platform.
Options
| Flag | Description |
|---|---|
-h, --help | Help for share |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos share vcluster
Share a virtual cluster with another Kosmos user or team
Synopsis
The kosmos share vcluster command is used to share a virtual cluster (vcluster) with another Kosmos user or team. This command allows you to assign specific roles or permissions to the shared user/team, enabling them to access the vcluster.
kosmos share vcluster [flags]
Examples
kosmos share vcluster --name <virtual-cluster-name>
kosmos share vcluster --name <virtual-cluster-name> --cluster <cluster-name>
kosmos share vcluster --name <virtual-cluster-name> --cluster <cluster-name> --user <user-name>
Options
| Flag | Description |
|---|---|
--cluster string | Cluster to use |
--cluster-role string | Cluster role which is assigned to user or team for that space (default "loft-cluster-space-admin") |
--devspace string | Devspace to get virtual cluster from |
-h, --help | Help for vcluster |
-n, --name string | Name of virtual cluster |
--team string | Team to share the space with. The team needs to have access to the cluster |
--user string | User to share the space with. The user needs to have access to the cluster |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos sleep
Put space or virtual cluster to sleep
Synopsis
The kosmos sleep command is used to put specified space or vcluster in a sleep mode, effectively pausing them.
Options
| Flag | Description |
|---|---|
-h, --help | Help for sleep |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos sleep vcluster
Put a virtual cluster to sleep
Synopsis
The kosmos sleep vcluster command is used to put a vcluster to sleep. You can also set a duration for how long the vcluster will remain asleep.
kosmos sleep vcluster [flags]
Examples
kosmos sleep vcluster --name <virtual-cluster-name>
kosmos sleep vcluster --name <virtual-cluster-name> --devspace <devspace-name>
Options
| Flag | Description |
|---|---|
-d, --devspace string | Devspace to get virtual cluster from |
-h, --help | Help for vcluster |
-n, --name string | Name of virtual cluster to put to sleep |
--prevent-wakeup kosmos wakeup vcluster | The amount of seconds this vcluster should sleep until it can be woken up again (use 0 for infinite sleeping). During this time the space can only be woken up by kosmos wakeup vcluster, manually deleting the annotation on the namespace or through the Kosmos UI (default -1) |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos token
Print access token to a Kosmos instance
Synopsis
The kosmos token command is used to print access token to a Kosmos instance.
kosmos token [flags]
Examples
kosmos token
Options
| Flag | Description |
|---|---|
--direct-cluster-endpoint | When enabled prints a direct cluster endpoint token |
-h, --help | Help for token |
--project string | The project containing the virtual cluster |
--virtual-cluster string | The virtual cluster |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos uninstall
Uninstall Kosmos resources
Synopsis
The kosmos uninstall command is used to uninstall Kosmos resources.
Options
| Flag | Description |
|---|---|
-h, --help | Help for uninstall |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos uninstall app
Uninstall an app
Synopsis
The kosmos uninstall app command is used to uninstall an app.
kosmos uninstall app [flags]
Examples
kosmos uninstall app
--name <app-name>
--version <app-version>
--parameter-file <path-to-parameter-file>
--release-name <release-name>
--target-cluster <target-cluster-name>
--fleet <fleet-name>
--devspace <devspace-name>
--target-namespace <target-namespace>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
applicationRoles:
- description: ""
displayName: ""
role: ""
verbs:
- ""
clusters:
- ""
config:
annotations: null
bash:
clusterRole: ""
image: ""
podSecurityContext:
appArmorProfile:
localhostProfile: ""
type: ""
fsGroup: 0
fsGroupChangePolicy: ""
runAsGroup: 0
runAsNonRoot: false
runAsUser: 0
seLinuxChangePolicy: ""
seLinuxOptions:
level: ""
role: ""
type: ""
user: ""
seccompProfile:
localhostProfile: ""
type: ""
supplementalGroups:
- 0
supplementalGroupsPolicy: ""
sysctls:
- name: ""
value: ""
windowsOptions:
gmsaCredentialSpec: ""
gmsaCredentialSpecName: ""
hostProcess: false
runAsUserName: ""
script: ""
securityContext:
allowPrivilegeEscalation: false
appArmorProfile:
localhostProfile: ""
type: ""
capabilities:
add:
- ""
drop:
- ""
privileged: false
procMount: ""
readOnlyRootFilesystem: false
runAsGroup: 0
runAsNonRoot: false
runAsUser: 0
seLinuxOptions:
level: ""
role: ""
type: ""
user: ""
seccompProfile:
localhostProfile: ""
type: ""
windowsOptions:
gmsaCredentialSpec: ""
gmsaCredentialSpecName: ""
hostProcess: false
runAsUserName: ""
chart:
insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
repoURL: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
version: ""
manifests: ""
parameters: ""
values: ""
defaultNamespace: ""
description: ""
displayName: ""
helm:
insecure: false
name: ""
password: ""
repoUrl: ""
username: ""
values: ""
version: ""
icon: ""
manifests: ""
owner:
team: ""
user: ""
parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
readme: ""
recommendedApp:
- ""
streamContainer:
container: ""
selector:
matchExpressions:
- key: ""
operator: ""
values:
- ""
matchLabels: null
timeout: ""
versions:
- config:
annotations: null
bash:
clusterRole: ""
image: ""
podSecurityContext:
appArmorProfile:
localhostProfile: ""
type: ""
fsGroup: 0
fsGroupChangePolicy: ""
runAsGroup: 0
runAsNonRoot: false
runAsUser: 0
seLinuxChangePolicy: ""
seLinuxOptions:
level: ""
role: ""
type: ""
user: ""
seccompProfile:
localhostProfile: ""
type: ""
supplementalGroups:
- 0
supplementalGroupsPolicy: ""
sysctls:
- name: ""
value: ""
windowsOptions:
gmsaCredentialSpec: ""
gmsaCredentialSpecName: ""
hostProcess: false
runAsUserName: ""
script: ""
securityContext:
allowPrivilegeEscalation: false
appArmorProfile:
localhostProfile: ""
type: ""
capabilities:
add:
- ""
drop:
- ""
privileged: false
procMount: ""
readOnlyRootFilesystem: false
runAsGroup: 0
runAsNonRoot: false
runAsUser: 0
seLinuxOptions:
level: ""
role: ""
type: ""
user: ""
seccompProfile:
localhostProfile: ""
type: ""
windowsOptions:
gmsaCredentialSpec: ""
gmsaCredentialSpecName: ""
hostProcess: false
runAsUserName: ""
chart:
insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
repoURL: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
version: ""
manifests: ""
parameters: ""
values: ""
defaultNamespace: ""
icon: ""
parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
readme: ""
streamContainer:
container: ""
selector:
matchExpressions:
- key: ""
operator: ""
values:
- ""
matchLabels: null
timeout: ""
version: ""
wait: false
wait: false
Options
| Flag | Description |
|---|---|
--devspace string | target devspace of the app |
--dry-run | Outputs the yaml that would be sent as the request payload |
--fleet string | target fleet of the app |
-h, --help | Help for app |
--name string | Name of the app template to install from |
--parameter-file string | parameter file(yaml) for the app |
--release-name string | release name |
--skeleton | Outputs skeleton YAML that can be used with the –file flag |
--target-cluster string | target cluster name |
--target-namespace string | Namespace. Default: kosmos-system |
--version string | Version of the app template |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update
Update Kosmos resources
Synopsis
The kosmos update command is used to update configuration of specified Kosmos resources. This command ensures that the configuration is up to date, which includes settings, preferences, or updates to the configurations that Kosmos environment relies on.
Options
| Flag | Description |
|---|---|
-h, --help | Help for update |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update aks
Update an AKS cluster
Synopsis
The kosmos update aks command is used to update configuration of a specified Azure Kubernetes Service (AKS) cluster.
kosmos update aks [flags]
Examples
kosmos update aks --file <path-to-yaml-file>
kosmos update aks --file <path-to-yaml-file> --replace
kosmos update aks --file <path-to-yaml-file> --fleet <fleet-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
aksConfig:
authBaseUrl: ""
authorizedIpRanges:
- ""
baseUrl: ""
clientID: ""
clusterName: ""
deleteOnDetachment: false
dnsPrefix: ""
dnsServiceIp: ""
httpApplicationRouting: false
imported: false
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
kubernetesVersion: ""
linuxAdminUsername: ""
loadBalancerSku: ""
logAnalyticsWorkspaceGroup: ""
logAnalyticsWorkspaceName: ""
managedIdentity: false
monitoring: false
networkPlugin: ""
networkPolicy: ""
nodePools:
- availabilityZones:
- ""
count: 0
enableAutoScaling: false
maxCount: 0
maxPods: 0
maxSurge: ""
minCount: 0
mode: ""
name: ""
nodeLabels: null
nodeTaints:
- ""
orchestratorVersion: ""
osDiskSizeGB: 0
osDiskType: ""
osType: ""
vmSize: ""
vnetSubnetID: ""
nodeResourceGroup: ""
outboundType: ""
podCidr: ""
privateCluster: false
privateDnsZone: ""
resourceGroup: ""
resourceLocation: ""
serviceCidr: ""
sshPublicKey: ""
subnet: ""
subscriptionID: ""
tags: null
tenantID: ""
userAssignedIdentity: ""
virtualNetwork: ""
virtualNetworkResourceGroup: ""
authorization:
adminTeams:
- ""
adminUsers:
- ""
binaryAuthorization:
evaluationMode: ""
description: ""
displayName: ""
loggingConfig:
componentConfig:
enableComponents:
- ""
monitoringConfig:
managedPrometheusConfig:
enabled: false
managedThanosConfig:
enabled: false
name: ""
oidcConfig:
issuerUri: ""
jwks: ""
owner: ""
Options
| Flag | Description |
|---|---|
--config-deleteondetachment | (Default true) |
--description string | Description of AKS cluster |
--displayname string | Display name of AKS cluster |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Update AKS cluster from a YAML file |
--fleet string | Fleet of AKS cluster |
-h, --help | Help for aks |
--name string | Name of AKS cluster |
--replace | If enabled, replaces an existing AKS cluster |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update aksoidcconnect
Update an AKS OIDC connect
Synopsis
The kosmos update aksoidcconnect command is used to update configuration of a specified AKS OIDC connect.
kosmos update aksoidcconnect [flags]
Examples
kosmos update aksoidcconnect --file <path-to-yaml-file>
kosmos update aksoidcconnect --file <path-to-yaml-file> --fleet <fleet-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
clientID: ""
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
name: ""
subscriptionID: ""
tenantID: ""
Options
| Flag | Description |
|---|---|
--client-id string | Client ID for AKS OIDC Connect |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Update AKS OIDC connect from a YAML file |
--fleet string | Fleet of AKS OIDC connect |
-h, --help | Help for aksoidcconnect |
--jwt-claims string | JWT Claims in JSON format e.g. ‘{"aud": " ", "iss": " ", "sub": " "}’ |
--name string | Name of AKS OIDC connect |
--subscription-id string | Subscription id for AKS OIDC connect |
--tenant-id string | Tenant ID for AKS OIDC connect |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update app
Update an app
Synopsis
The kosmos update app command is used to update configuration of a specified app.
kosmos update app [flags]
Examples
kosmos update app --file <path-to-yaml-file>
kosmos update app
--name <app-name>
--description <description>
--displayname <display-name>
--clusters "<cluster-name>[,<cluster-name>...]"
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
applicationRoles:
- description: ""
displayName: ""
role: ""
verbs:
- ""
clusters:
- ""
config:
annotations: null
bash:
clusterRole: ""
image: ""
podSecurityContext:
appArmorProfile:
localhostProfile: ""
type: ""
fsGroup: 0
fsGroupChangePolicy: ""
runAsGroup: 0
runAsNonRoot: false
runAsUser: 0
seLinuxChangePolicy: ""
seLinuxOptions:
level: ""
role: ""
type: ""
user: ""
seccompProfile:
localhostProfile: ""
type: ""
supplementalGroups:
- 0
supplementalGroupsPolicy: ""
sysctls:
- name: ""
value: ""
windowsOptions:
gmsaCredentialSpec: ""
gmsaCredentialSpecName: ""
hostProcess: false
runAsUserName: ""
script: ""
securityContext:
allowPrivilegeEscalation: false
appArmorProfile:
localhostProfile: ""
type: ""
capabilities:
add:
- ""
drop:
- ""
privileged: false
procMount: ""
readOnlyRootFilesystem: false
runAsGroup: 0
runAsNonRoot: false
runAsUser: 0
seLinuxOptions:
level: ""
role: ""
type: ""
user: ""
seccompProfile:
localhostProfile: ""
type: ""
windowsOptions:
gmsaCredentialSpec: ""
gmsaCredentialSpecName: ""
hostProcess: false
runAsUserName: ""
chart:
insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
repoURL: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
version: ""
manifests: ""
parameters: ""
values: ""
defaultNamespace: ""
description: ""
displayName: ""
helm:
insecure: false
name: ""
password: ""
repoUrl: ""
username: ""
values: ""
version: ""
icon: ""
manifests: ""
owner:
team: ""
user: ""
parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
readme: ""
recommendedApp:
- ""
streamContainer:
container: ""
selector:
matchExpressions:
- key: ""
operator: ""
values:
- ""
matchLabels: null
timeout: ""
versions:
- config:
annotations: null
bash:
clusterRole: ""
image: ""
podSecurityContext:
appArmorProfile:
localhostProfile: ""
type: ""
fsGroup: 0
fsGroupChangePolicy: ""
runAsGroup: 0
runAsNonRoot: false
runAsUser: 0
seLinuxChangePolicy: ""
seLinuxOptions:
level: ""
role: ""
type: ""
user: ""
seccompProfile:
localhostProfile: ""
type: ""
supplementalGroups:
- 0
supplementalGroupsPolicy: ""
sysctls:
- name: ""
value: ""
windowsOptions:
gmsaCredentialSpec: ""
gmsaCredentialSpecName: ""
hostProcess: false
runAsUserName: ""
script: ""
securityContext:
allowPrivilegeEscalation: false
appArmorProfile:
localhostProfile: ""
type: ""
capabilities:
add:
- ""
drop:
- ""
privileged: false
procMount: ""
readOnlyRootFilesystem: false
runAsGroup: 0
runAsNonRoot: false
runAsUser: 0
seLinuxOptions:
level: ""
role: ""
type: ""
user: ""
seccompProfile:
localhostProfile: ""
type: ""
windowsOptions:
gmsaCredentialSpec: ""
gmsaCredentialSpecName: ""
hostProcess: false
runAsUserName: ""
chart:
insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
repoURL: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
version: ""
manifests: ""
parameters: ""
values: ""
defaultNamespace: ""
icon: ""
parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
readme: ""
streamContainer:
container: ""
selector:
matchExpressions:
- key: ""
operator: ""
values:
- ""
matchLabels: null
timeout: ""
version: ""
wait: false
wait: false
Options
| Flag | Description |
|---|---|
--clusters strings | Clusters the app can be installed in (comma separated) |
--description string | Description of app |
--displayname string | Display name of app |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Update app from a YAML file |
-h, --help | Help for app |
--name string | Name of app |
--owner-team string | Owner team |
--owner-user string | Owner user |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update applicationrole
Update an application role
Synopsis
The kosmos update applicationrole command is used to update configuration of a specified application role.
kosmos update applicationrole [flags]
Examples
kosmos update applicationrole --file app.yml
kosmos update applicationrole \
--name <application-role-name> \
--users <user-name>[,<user-name>...] \
--teams <team-name>[,<team-name>...] \
--subject-file <path-to-subject-file> \
--file <path-to-yaml-file>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
description: ""
displayName: ""
teams:
- ""
users:
- ""
verbs:
- ""
Options
| Flag | Description |
|---|---|
--devspace string | devspace associated with application role |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Update application role from a YAML file |
--fleet string | fleet associated with application role |
-h, --help | Help for applicationrole |
--name string | name of appllication role |
--subject-file string | subject file defines users and teams only |
--teams strings | List of team (group) subjects |
--users strings | List of user subjects |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update clusterroletemplate
Update a cluster role template
Synopsis
The kosmos update clusterroletemplate command is used to update configuration of a specified cluster role template.
kosmos update clusterroletemplate [flags]
Examples
kosmos update clusterroletemplate --file <path-to-yaml-file>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusterRoleTemplate:
aggregationRule:
clusterRoleSelectors:
- matchExpressions:
- key: ""
operator: ""
values:
- ""
matchLabels: null
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
rules:
- apiGroups:
- ""
nonResourceURLs:
- ""
resourceNames:
- ""
resources:
- ""
verbs:
- ""
clusters:
- ""
description: ""
displayName: ""
localClusterRoleTemplate:
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
clusterRoleTemplate:
aggregationRule:
clusterRoleSelectors:
- matchExpressions:
- key: ""
operator: ""
values:
- ""
matchLabels: null
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
rules:
- apiGroups:
- ""
nonResourceURLs:
- ""
resourceNames:
- ""
resources:
- ""
verbs:
- ""
description: ""
displayName: ""
management: false
owner:
team: ""
user: ""
Options
| Flag | Description |
|---|---|
--access string | Access rights for users and teams in JSON format e.g. ‘[{"name": " ", "verbs": [" "," "], "subresources": [" "," "], "users": [" "," "], "teams": [" "," "]}]’ |
--clusters strings | Clusters the template should be applied on (comma separated) |
--description string | Description of cluster role template |
--displayname string | Display name of cluster role template |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Update cluster role template from a YAML file |
-h, --help | Help for clusterroletemplate |
--name string | Name of cluster role template |
--owner-team string | Owner team |
--owner-user string | Owner user |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update devspace
Update a devspace
Synopsis
The kosmos update devspace command is used to update configuration of a specified devspace.
kosmos update devspace [flags]
Examples
kosmos update devspace --file <path-to-yaml-file>
kosmos update devspace --file <path-to-yaml-file> --users <user-name>[,<user-name>...]
kosmos update devspace --file <path-to-yaml-file> --allowedtemplates <template-name>[,<template-name>...]
kosmos update devspace --name <devspace-name> --description <description> --displayname <display-name> --allowedtemplates <template-name>[,<template-name>...] --users <user-name>[,<user-name>...]
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- devSpaceTeams:
- ""
name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
allowedClusters:
- name: ""
allowedTemplates:
- group: ""
isDefault: false
kind: ""
name: ""
defaultDevSpaceRole: ""
description: ""
displayName: ""
members:
- clusterRole: ""
group: ""
kind: ""
name: ""
observability: {}
owner:
team: ""
user: ""
permissions:
- fleetRole: ""
teams:
- ""
users:
- ""
quotas:
devspace: null
user: null
users:
- ""
Options
| Flag | Description |
|---|---|
--allowed-clusters strings | Clusters allowed in devspace (comma separated) |
--allowed-templates strings | Templates allowed in devspace (comma separated) |
--default-devspace-role string | Default Role for devspace |
--description string | Description of devspace |
--displayname string | Display name of devspace |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Update devspace from a YAML file |
-h, --help | Help for devspace |
--name string | Name of devspace |
--owner-team string | Owner team |
--owner-user string | Owner user |
--users strings | Users of devspace (comma separated) |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update devspaceclusteraccess
Update a devspace cluster access
Synopsis
The kosmos update devspaceclusteraccess command is used to update configuration of a specified devspace cluster access.
kosmos update devspaceclusteraccess [flags]
Examples
kosmos update devspaceclusteraccess --file <path-to-yaml-file>
kosmos update devspaceclusteraccess --name <devspace-cluster-access-name> --devspace <devspace-name> --clusters <cluster-name>[,<cluster-name>...]
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusters:
- ""
description: ""
displayName: ""
localClusterAccessTemplate:
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
clusterRoles:
- name: ""
description: ""
displayName: ""
priority: 0
teams:
- ""
users:
- team: ""
user: ""
owner:
team: ""
user: ""
Options
| Flag | Description |
|---|---|
--access string | Access rights for users and teams in JSON format e.g. ‘[{"name": " ", "verbs": [" "," "], "subresources": [" "," "], "users": [" "," "], "teams": [" "," "]}]’ |
--clusters strings | Clusters the template should be applied on (comma separated) |
--description string | Description of devspace cluster access |
--devspace string | Devspace of devspace cluster access |
--displayname string | Display name of devspace cluster access |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Update devspace cluster access from a YAML file |
-h, --help | Help for devspaceclusteraccess |
--name string | Name of devspace cluster access |
--owner-team string | Owner team |
--owner-user string | Owner user |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update devspacerole
Update a devspace role
Synopsis
The kosmos update devspacerole command is used to update configuration of a specified devspace role.
kosmos update devspacerole [flags]
Examples
kosmos update devspacerole --file <path-to-yaml-file>
kosmos update devspacerole --name <devspace-role-name> --devspace <devspace-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
description: ""
displayName: ""
rules:
- resources:
- ""
verbs:
- ""
Options
| Flag | Description |
|---|---|
--description string | Description of devspace role |
--devspace string | Devspace of devspace role |
--displayname string | Display name of devspace role |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Update devspace role from a YAML file |
-h, --help | Help for devspacerole |
--name string | Name of devspace role |
--rules string | Access rules associated with devspace role in JSON format e.g. ‘[{"resources": [" "," "], "verbs": [" "," "]}]’ |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update devspacesecret
Update a devspace secret
Synopsis
The kosmos update devspacesecret command is used to update configuration of a specified devspace secret.
kosmos update devspacesecret [flags]
Examples
kosmos update devspacesecret --file <path-to-yaml-file>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
data: null
description: ""
displayName: ""
vaultRef:
mountPath: ""
secretPath: ""
Options
| Flag | Description |
|---|---|
--description string | Description of devspace secret |
--devspace string | Devspace of devspace secret |
--displayname string | Display name of devspace secret |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Update devspace secret from a YAML file |
-h, --help | Help for devspacesecret |
--name string | Name of devspace secret |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update devspaceteam
Update a devspace team
Synopsis
The kosmos update devspaceteam command is used to update configuration of a specified devspace team.
kosmos update devspaceteam [flags]
Examples
kosmos update devspaceteam --file <path-to-yaml-file>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusterRoles:
- name: ""
description: ""
displayName: ""
groups:
- ""
imagePullSecrets:
- apiGroup: ""
key: ""
kind: ""
secretName: ""
secretNamespace: ""
owner:
team: ""
user: ""
username: ""
users:
- ""
Options
| Flag | Description |
|---|---|
--access string | Access rights for users and teams in JSON format e.g. ‘[{"name": " ", "verbs": [" "," "], "subresources": [" "," "], "users": [" "," "], "teams": [" "," "]}]’ |
--clusterroles strings | Names of cluster roles to be assigned to the users (comma separated) |
--description string | Description of devspace team |
--devspace string | Devspace of devspace team |
--displayname string | Display name of devspace team |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Update devspace team from a YAML file |
--groups strings | Groups that belong to the devspace team (comma separated) |
-h, --help | Help for devspaceteam |
--name string | Name of devspace team |
--owner-team string | Owner team |
--owner-user string | Owner user |
--username string | Username of devspace team |
--users strings | Users that belong to the devspace team (comma separated) |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update eks
Update an EKS cluster
Synopsis
The kosmos update eks command is used to update configuration of a specified Elastic Kubernetes Service (EKS) cluster.
kosmos update eks [flags]
Examples
kosmos update eks --file <path-to-yaml-file>
kosmos update eks --file <path-to-yaml-file> --replace
kosmos update eks --file <path-to-yaml-file> --fleet <fleet-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
authorization:
adminTeams:
- ""
adminUsers:
- ""
binaryAuthorization:
evaluationMode: ""
description: ""
displayName: ""
eksConfig:
bootstrapAccessEntry:
principalArn: ""
clusterRole: ""
deleteOnDetachment: false
displayName: ""
ebsCSIDriver: false
imported: false
kmsKey: ""
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
kosmosRoleArn: ""
kubernetesVersion: ""
loggingTypes:
- ""
nodeGroups:
- arm: false
desiredSize: 0
diskSize: 0
ec2SshKey: ""
gpu: false
imageId: ""
instanceType: ""
labels: null
launchTemplate:
id: ""
name: ""
version: 0
maxSize: 0
minSize: 0
nodeRole: ""
nodegroupName: ""
requestSpotInstances: false
resourceTags: null
spotInstanceTypes:
- ""
subnets:
- ""
tags: null
userData: ""
version: ""
privateAccess: false
publicAccess: false
publicAccessSources:
- ""
region: ""
secretsEncryption: false
securityGroups:
- ""
subnets:
- ""
tags: null
loggingConfig:
componentConfig:
enableComponents:
- ""
monitoringConfig:
managedPrometheusConfig:
enabled: false
managedThanosConfig:
enabled: false
name: ""
oidcConfig:
issuerUri: ""
jwks: ""
owner: ""
Options
| Flag | Description |
|---|---|
--config-deleteondetachment | Delete cluster when detached from kosmos. Required if import is false. (Default true) |
--config-kosmosrolearn string | ARN of the role to manage the EKS cluster |
--config-kubernetesversion string | Required if imported is false |
--description string | Description of EKS cluster |
--displayname string | Display name of EKS cluster |
--dry-run | If enabled, doesn’t perform update operation on server |
-f, --file string | Update EKS cluster from a YAML file |
--fleet string | Fleet of EKS cluster |
-h, --help | Help for eks |
--name string | Name of EKS cluster |
--replace | If enabled, replaces an existing eks cluster |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update eksoidcconnect
Update an EKS OIDC connect
Synopsis
The kosmos update eksoidcconnect command is used to update configuration of a specified EKS OIDC connect.
kosmos update eksoidcconnect [flags]
Examples
kosmos update eksoidcconnect --file <path-to-yaml-file>
kosmos update eksoidcconnect --file <path-to-yaml-file> --fleet <fleet-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
description: ""
disabled: false
displayName: ""
groups:
- ""
identity:
connector: ""
connectorData: AA==
email: ""
emailVerified: false
groups:
- ""
preferredUsername: ""
userId: ""
username: ""
identityRefresh: {}
key: ""
oidcLogin:
accessToken: AA==
idToken: AA==
lastRefresh: {}
refreshToken: AA==
oidcProvider:
clientId: ""
nonce: ""
redirectUri: ""
scopes: ""
parent: ""
scope:
allowLoftCli: false
clusters:
- cluster: ""
projects:
- project: ""
roles:
- projects:
- ""
role: ""
virtualClusters:
- ""
rules:
- cluster: ""
namespaces:
- ""
nonResourceURLs:
- ""
requestTargets:
- ""
resources:
- group: ""
resourceNames:
- ""
resources:
- ""
verbs:
- ""
virtualClusters:
- name: ""
namespace: ""
spaces:
- project: ""
space: ""
virtualClusters:
- project: ""
virtualCluster: ""
subject: ""
team: ""
ttl: 0
ttlAfterLastActivity: false
type: ""
user: ""
Options
| Flag | Description |
|---|---|
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Update EKS OIDC connect from a YAML file |
--fleet string | Fleet of EKS OIDC connect |
-h, --help | Help for eksoidcconnect |
--jwt-claims string | JWT claims in JSON format e.g. ‘{"aud": " ", "iss": " ", "sub": " "}’ |
--kosmos-role-arn string | ARN of the role used to manage the EKS cluster |
--name string | Name of EKS OIDC connect |
--region string | Region of the cluster |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update fleet
Update a fleet
Synopsis
The kosmos update fleet command is used to update configuration of a specified fleet.
kosmos update fleet [flags]
Examples
kosmos update fleet --file <path-to-yaml-file>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- fleetTeams:
- ""
name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusterAccess:
- clusterRole: ""
teams:
- ""
users:
- ""
defaultFleetRole: ""
description: ""
displayName: ""
members:
- clusterRole: ""
kind: ""
name: ""
observability: {}
owner:
team: ""
user: ""
permissions:
- fleetRole: ""
teams:
- ""
users:
- ""
users:
- ""
Options
| Flag | Description |
|---|---|
--description string | Description of fleet |
--displayname string | Display name of fleet |
-f, --file string | Update fleet from a YAML file |
-h, --help | Help for fleet |
--name string | Name of fleet |
--owning_team string | Owning team of fleet |
--owning_user string | Owning user of fleet |
--users strings | List of users assigned to fleet |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update fleetclusteraccess
Update a fleet cluster access
Synopsis
The kosmos update fleetclusteraccess command is used to update configuration of a specified fleet cluster access.
kosmos update fleetclusteraccess [flags]
Examples
kosmos update fleetclusteraccess --file <path-to-yaml-file>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusters:
- ""
description: ""
displayName: ""
localClusterAccessTemplate:
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
clusterRoles:
- name: ""
description: ""
displayName: ""
priority: 0
teams:
- ""
users:
- team: ""
user: ""
owner:
team: ""
user: ""
Options
| Flag | Description |
|---|---|
--access string | Access rights for users and teams in JSON format e.g. ‘[{"name": " ", "verbs": [" "," "], "subresources": [" "," "], "users": [" "," "], "teams": [" "," "]}]’ |
--clusters strings | Clusters the template should be applied on (comma separated) |
--description string | Description of fleet cluster access |
--displayname string | Display name of fleet cluster access |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Update fleet cluster access from a YAML file |
--fleet string | Fleet of fleet cluster access |
-h, --help | Help for fleetclusteraccess |
--name string | Name of fleet cluster access |
--owner-team string | Owner team |
--owner-user string | Owner user |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update fleetclusterroletemplate
Update a fleet cluster role template
Synopsis
The kosmos update fleetclusterroletemplate command is used to update configuration of a specified fleet cluster role template.
kosmos update fleetclusterroletemplate [flags]
Examples
kosmos update fleetclusterroletemplate --name <fleet-cluster-role-template-name> --file <path-to-yaml-file>
kosmos update fleetclusterroletemplate --name <fleet-cluster-role-template-name> --file <path-to-yaml-file> --fleet <fleet-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusterRoleTemplate:
aggregationRule:
clusterRoleSelectors:
- matchExpressions:
- key: ""
operator: ""
values:
- ""
matchLabels: null
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
rules:
- apiGroups:
- ""
nonResourceURLs:
- ""
resourceNames:
- ""
resources:
- ""
verbs:
- ""
clusters:
- ""
description: ""
displayName: ""
localClusterRoleTemplate:
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
clusterRoleTemplate:
aggregationRule:
clusterRoleSelectors:
- matchExpressions:
- key: ""
operator: ""
values:
- ""
matchLabels: null
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
rules:
- apiGroups:
- ""
nonResourceURLs:
- ""
resourceNames:
- ""
resources:
- ""
verbs:
- ""
description: ""
displayName: ""
management: false
owner:
team: ""
user: ""
Options
| Flag | Description |
|---|---|
--clusters strings | clusters this template applies on (comma separated) |
--description string | Description of fleet cluster role template (default "desc") |
--displayname string | Display Name of fleet cluster role template |
--dry-run | Outputs yaml template for fleet cluster role template |
-f, --file string | Update fleet cluster role template from a YAML file |
--fleet string | Fleet of fleet cluster role template |
-h, --help | Help for fleetclusterroletemplate |
--management | true if the role template should be in management instance |
-n, --name string | Name of fleet cluster role template |
--owning_team string | Owning team of the fleet |
--owning_user string | Owning user of the fleet |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update fleetrole
Update a fleet role
Synopsis
The kosmos update fleetrole command is used to update configuration of a specified fleet role.
kosmos update fleetrole [flags]
Examples
kosmos update fleetrole --file <path-to-yaml-file>
kosmos update fleetrole --name <fleet-role-name> --fleet <fleet-name> --description <description>
kosmos update fleetrole --name <fleet-role-name> --fleet <fleet-name> --rules <resource>=<verb>[,<resource>=<verb>...]
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
description: ""
rules:
- resources:
- ""
verbs:
- ""
Options
| Flag | Description |
|---|---|
--description string | Description of fleet role |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Update fleet role from a YAML file |
--fleet string | Name of owning fleet of fleet role |
-h, --help | Help for fleetrole |
--name string | Name of fleet role |
--rules stringToString | Fleet role rules. See examples for more info (default []) |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update fleetsecret
Update a fleet secret
Synopsis
The kosmos update fleetsecret command is used to update configuration of a specified fleet secret.
kosmos update fleetsecret [flags]
Examples
kosmos update fleetsecret --file <path-to-yaml-file>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
data: null
description: ""
displayName: ""
name: ""
namespace: ""
vaultRef:
mountPath: ""
secretPath: ""
Options
| Flag | Description |
|---|---|
--description string | Description of fleet secret |
--displayname string | Display name of fleet secret |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Update fleet secret from a YAML file |
--fleet string | Fleet of fleet secret |
-h, --help | Help for fleetsecret |
--name string | Name of fleet secret |
--secretname string | Name of secret in connected clusters |
--secretnamespace string | Namespace of secret in connected clusters |
--vaultmountpath string | Vault mount path for fleet secret |
--vaultsecretpath string | Vault secret path for fleet secret |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update fleetspacetemplate
Update a fleet space template
Synopsis
The kosmos update fleetspacetemplate command is used to update configuration of a specified fleet space template.
kosmos update fleetspacetemplate [flags]
Examples
kosmos update fleetspacetemplate --file <path-to-yaml-file>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
description: ""
displayName: ""
owner:
team: ""
user: ""
parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
template:
apps:
- name: ""
namespace: ""
parameters: ""
releaseName: ""
version: ""
charts:
- insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
releaseName: ""
releaseNamespace: ""
repoURL: ""
timeout: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
values: ""
version: ""
wait: false
instanceTemplate:
metadata:
annotations: null
labels: null
metadata:
annotations: null
labels: null
objects: ""
versions:
- parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
template:
apps:
- name: ""
namespace: ""
parameters: ""
releaseName: ""
version: ""
charts:
- insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
releaseName: ""
releaseNamespace: ""
repoURL: ""
timeout: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
values: ""
version: ""
wait: false
instanceTemplate:
metadata:
annotations: null
labels: null
metadata:
annotations: null
labels: null
objects: ""
version: ""
Options
| Flag | Description |
|---|---|
--description string | Description of fleet space template (default "desc") |
--displayname string | Display Name of fleet space template |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Update fleet space template from a YAML file |
--fleet string | Fleet of fleet space template |
-h, --help | Help for fleetspacetemplate |
-n, --name string | Name of fleet space template |
--owner-team string | Owner team |
--owner-user string | Owner user |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update fleetteam
Update a fleet team
Synopsis
The kosmos update fleetteam command is used to update configuration of a specified fleet team.
kosmos update fleetteam [flags]
Examples
kosmos update fleetteam --file <path-to-yaml-file>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusterRoles:
- name: ""
description: ""
displayName: ""
groups:
- ""
imagePullSecrets:
- apiGroup: ""
key: ""
kind: ""
secretName: ""
secretNamespace: ""
owner:
team: ""
user: ""
username: ""
users:
- ""
Options
| Flag | Description |
|---|---|
--access string | Access rights for users and teams in JSON format e.g. ‘[{"name": " ", "verbs": [" "," "], "subresources": [" "," "], "users": [" "," "], "teams": [" "," "]}]’ |
--clusterroles strings | Names of cluster roles to be assigned to the users (comma separated) |
--description string | Description of fleet team |
--displayname string | Display name of fleet team |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Update fleet team from a YAML file |
--fleet string | Fleet of fleet team |
--groups strings | Groups that belong to fleet team (comma separated) |
-h, --help | Help for fleetteam |
--name string | Name of fleet team |
--owner-team string | Owner team |
--owner-user string | Owner user |
--username string | Username of fleet team |
--users strings | Users that belong to fleet team (comma separated) |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update genericcluster
Update a generic cluster
Synopsis
The kosmos update genericcluster command is used to update configuration of a specified generic cluster.
kosmos update genericcluster [flags]
Examples
kosmos update genericcluster --file <path-to-yaml-file>
kosmos update genericcluster --file <path-to-yaml-file> --replace
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
authorization:
adminTeams:
- ""
adminUsers:
- ""
binaryAuthorization:
evaluationMode: ""
description: ""
displayName: ""
kubeConfig: ""
loggingConfig:
componentConfig:
enableComponents:
- ""
monitoringConfig:
managedPrometheusConfig:
enabled: false
managedThanosConfig:
enabled: false
name: ""
oidcConfig:
issuerUri: ""
jwks: ""
owner: ""
proxyConfig:
kubernetesSecret:
name: ""
namespace: ""
Options
| Flag | Description |
|---|---|
--cluster-region string | Region of generic cluster |
--description string | Description of generic cluster |
--displayname string | Display name of generic cluster |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Update generic cluster from a YAML file |
--fleet string | Fleet of generic cluster |
-h, --help | Help for genericcluster |
--kubeconfig string | Kubernetes config used to connect the cluster |
--kubernetes-version string | Kubernetes version of generic cluster |
--name string | Name of generic cluster |
--owner string | Owner of generic cluster |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update gke
Update a GKE cluster
Synopsis
The kosmos update gke command is used to update configuration of a specified Google Kubernetes Engine (GKE) cluster.
kosmos update gke [flags]
Examples
kosmos update gke --file <path-to-yaml-file>
kosmos update gke --file <path-to-yaml-file> --replace
kosmos update gke --file <path-to-yaml-file> --fleet <fleet-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
authorization:
adminTeams:
- ""
adminUsers:
- ""
binaryAuthorization:
evaluationMode: ""
description: ""
displayName: ""
gkeConfig:
autopilotConfig:
enabled: false
clusterAddons:
horizontalPodAutoscaling: false
httpLoadBalancing: false
networkPolicyConfig: false
clusterIpv4Cidr: ""
clusterName: ""
deleteOnDetachment: false
description: ""
enableKubernetesAlpha: false
googleCredentialSecret: ""
imported: false
ipAllocationPolicy:
clusterIpv4CidrBlock: ""
clusterSecondaryRangeName: ""
createSubnetwork: false
nodeIpv4CidrBlock: ""
servicesIpv4CidrBlock: ""
servicesSecondaryRangeName: ""
subnetworkName: ""
useIpAliases: false
keyName: ""
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
kubernetesVersion: ""
labels: null
locations:
- ""
loggingService: ""
maintenanceWindow: ""
masterAuthorizedNetworks:
cidrBlocks:
- cidrBlock: ""
displayName: ""
enabled: false
monitoringService: ""
network: ""
networkPolicyEnabled: false
nodePools:
- autoscaling:
enabled: false
maxNodeCount: 0
minNodeCount: 0
config:
diskSizeGb: 0
diskType: ""
imageType: ""
labels: null
localSsdCount: 0
machineType: ""
oauthScopes:
- ""
preemptible: false
tags:
- ""
taints:
- effect: ""
key: ""
value: ""
initialNodeCount: 0
management:
autoRepair: false
autoUpgrade: false
maxPodsConstraint: 0
name: ""
version: ""
privateClusterConfig:
enablePrivateEndpoint: false
enablePrivateNodes: false
masterIpv4CidrBlock: ""
projectID: ""
projectNumber: ""
region: ""
serviceAccount: ""
subnetwork: ""
workloadIdentityPoolId: ""
workloadIdentityProviderId: ""
zone: ""
loggingConfig:
componentConfig:
enableComponents:
- ""
monitoringConfig:
managedPrometheusConfig:
enabled: false
managedThanosConfig:
enabled: false
name: ""
owner: ""
Options
| Flag | Description |
|---|---|
--config-deleteondetachment | (Default true) |
--description string | Description of GKE cluster |
--displayname string | Display name of GKE cluster |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Update GKE cluster from a YAML file |
--fleet string | Fleet of GKE cluster |
-h, --help | Help for gke |
--name string | Name of GKE cluster |
--replace | If enabled, replaces an existing GKE cluster |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update gkeoidcconnect
Update a GKE OIDC connect
Synopsis
The kosmos update gkeoidcconnect command is used to update configuration of a specified GKE OIDC connect.
kosmos update gkeoidcconnect [flags]
Examples
kosmos update gkeoidcconnect --file <path-to-yaml-file>
kosmos update gkeoidcconnect --file <path-to-yaml-file> --fleet <fleet-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
name: ""
projectNumber: ""
serviceAccount: ""
workloadIdentityPoolId: ""
workloadIdentityProviderId: ""
Options
| Flag | Description |
|---|---|
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Update GKE OIDC connect from a YAML file |
--fleet string | Fleet of GKE OIDC connect |
-h, --help | Help for gkeoidcconnect |
--jwt-claims string | JWT claims in JSON format e.g. ‘{"aud": " ", "iss": " ", "sub": " "}’ |
--name string | Name of GKE OIDC connect |
--project-number string | Project number |
--service-account string | Service account for GKE OIDC connect |
--workload-identity-pool-id string | Workload identity pool ID |
--workload-identity-provider-id string | Workload identity provider ID |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update mks
Update an MKS cluster
Synopsis
The kosmos update mks command is used to update configuration of a specified Managed Kubernetes Service (MKS) cluster.
kosmos update mks [flags]
Examples
kosmos update mks --file <path-to-yaml-file>
kosmos update mks --file <path-to-yaml-file> --replace
kosmos update mks --file <path-to-yaml-file> --fleet <fleet-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
authorization:
adminTeams:
- ""
adminUsers:
- ""
binaryAuthorization:
evaluationMode: ""
description: ""
displayName: ""
loggingConfig:
componentConfig:
enableComponents:
- ""
mksConfig:
clusterRole: ""
deleteOnDetachment: false
displayName: ""
ebsCSIDriver: false
imported: false
kmsKey: ""
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
kosmosRoleArn: ""
kubernetesVersion: ""
loggingTypes:
- ""
nodeGroups:
- desiredSize: 0
diskSize: 0
ec2SshKey: ""
gpu: false
imageId: ""
instanceType: ""
labels: null
launchTemplate:
id: ""
name: ""
version: 0
maxSize: 0
minSize: 0
nodeRole: ""
nodegroupName: ""
requestSpotInstances: false
resourceTags: null
spotInstanceTypes:
- ""
subnets:
- ""
tags: null
userData: ""
version: ""
privateAccess: false
publicAccess: false
publicAccessSources:
- ""
region: ""
secretsEncryption: false
securityGroups:
- ""
subnets:
- ""
tags: null
monitoringConfig:
managedPrometheusConfig:
enabled: false
managedThanosConfig:
enabled: false
name: ""
oidcConfig:
issuerUri: ""
jwks: ""
owner: ""
Options
| Flag | Description |
|---|---|
--config-deleteondetachment | Delete cluster when detached from kosmos. Required if import is false. (Default true) |
--config-kosmosrolearn string | ARN of the role to manage the MKS cluster. |
--config-kubernetesversion string | Required if imported is false |
--description string | Description of MKS cluster |
--displayname string | Display name of MKS cluster |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Update MKS cluster from a YAML file |
--fleet string | Fleet of MKS cluster |
-h, --help | Help for mks |
--name string | Name of MKS cluster |
--replace | If enabled, replaces an existing MKS cluster |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update mksoidcconnect
Update an MKS OIDC connect
Synopsis
The kosmos update mksoidcconnect command is used to update configuration of a specified MKS OIDC connect.
kosmos update mksoidcconnect [flags]
Examples
kosmos update mksoidcconnect --file <path-to-yaml-file>
kosmos update mksoidcconnect --file <path-to-yaml-file> --fleet <fleet-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
kosmosJWTClaims:
aud: ""
customs: null
exp: 0
iat: 0
iss: ""
jti: ""
nbf: 0
sub: ""
kosmosRoleArn: ""
name: ""
region: ""
Options
| Flag | Description |
|---|---|
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Update MKS OIDC connect from a YAML file |
--fleet string | Fleet of MKS OIDC connect |
-h, --help | Help for mksoidcconnect |
--jwt-claims string | JWT claims in JSON format e.g. ‘{"aud": " ", "iss": " ", "sub": " "}’ |
--kosmos-role-arn string | ARN of the role used to manage the MKS cluster |
--name string | Name of MKS OIDC connect |
--region string | Region of cluster |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update vaultconfiguration
Update a vault configuration
Synopsis
The kosmos update vaultconfiguration command is used to update configuration of a specified vault configuration.
kosmos update vaultconfiguration [flags]
Examples
kosmos update vaultconfiguration --file <path-to-yaml-file>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
address: ""
auth:
token: ""
tokenSecretRef:
key: ""
name: ""
optional: false
enabled: false
syncInterval: ""
Options
| Flag | Description |
|---|---|
--address string | Address of vault configuration |
--auth-secret-key string | Auth secret key of vault configuration |
--auth-secret-name string | Auth secret name of vault configuration |
--auth-token string | Auth token of vault configuration |
--devspace string | DevSpace of vault configuration |
--dry-run | Outputs the yaml that would be sent as the request payload |
--enabled | Whether vault configuration is enabled |
-f, --file string | Update vault configuration from a YAML file |
--fleet string | Fleet of vault configuration |
-h, --help | Help for vaultconfiguration |
--name string | Name of vault configuration |
--sync-interval string | Sync interval of vault configuration |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update vcluster
Update a virtual cluster
Synopsis
The kosmos update vcluster command is used to update configuration of a specified virtual cluster.
kosmos update vcluster [flags]
Examples
kosmos update vcluster --name <virtual-cluster-name>kosmos update vcluster --name <virtual-cluster-name> --devspace <devspace-name> --file <path-to-yaml-file> --display-name <display-name> --description <description> --user <user-name> --team <team-name>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- devSpaceTeams:
- ""
name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
clusterRef:
cluster: ""
namespace: ""
virtualCluster: ""
deletionProtection: false
description: ""
displayName: ""
extraAccessRules:
- clusterRole: ""
devSpaceTeams:
- ""
teams:
- ""
users:
- ""
owner:
team: ""
user: ""
parameters: ""
sleepModeConfig:
deleteAfter: 0
forceSleep: false
forceSleepDuration: 0
ignoreActiveConnections: false
ignoreAll: false
ignoreGroups: ""
ignoreIngresses: false
ignoreResourceNames: ""
ignoreResourceVerbs: ""
ignoreResources: ""
ignoreUserAgents: ""
ignoreVClusters: false
ignoreVerbs: ""
sleepAfter: 0
sleepSchedule: ""
timezone: ""
wakeupSchedule: ""
templateRef:
name: ""
syncOnce: false
version: ""
Options
| Flag | Description |
|---|---|
--description string | The description to show in the UI for this virtual cluster |
--devspace string | The DevSpace to use |
--display-name string | The display name to show in the UI for this virtual cluster |
-f, --file string | Create virtual cluster from a YAML file |
-h, --help | Help for vcluster |
-n, --name string | Name of virtual cluster |
--team string | The team to create the space for |
--user string | The user to create the space for |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos update vclustertemplate
Update a virtual cluster template
Synopsis
The kosmos update vclustertemplate command is used to update configuration of a specified virtual cluster template.
kosmos update vclustertemplate [flags]
Examples
kosmos update vclustertemplate --file <path-to-yaml-file>
spec.yaml
metadata:
annotations: null
creationTimestamp: {}
deletionGracePeriodSeconds: 0
deletionTimestamp: {}
finalizers:
- ""
generateName: ""
generation: 0
labels: null
name: ""
namespace: ""
ownerReferences:
- apiVersion: ""
blockOwnerDeletion: false
controller: false
kind: ""
name: ""
uid: ""
resourceVersion: ""
selfLink: ""
uid: ""
spec:
access:
- devSpaceTeams:
- ""
name: ""
subresources:
- ""
teams:
- ""
users:
- ""
verbs:
- ""
description: ""
displayName: ""
owner:
team: ""
user: ""
parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
template:
access:
defaultClusterRole: ""
rules:
- clusterRole: ""
devSpaceTeams:
- ""
teams:
- ""
users:
- ""
accessPoint:
ingress:
enabled: false
apps:
- name: ""
namespace: ""
parameters: ""
releaseName: ""
version: ""
charts:
- insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
releaseName: ""
releaseNamespace: ""
repoURL: ""
timeout: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
values: ""
version: ""
wait: false
forwardToken: false
helmRelease:
chart:
name: ""
password: ""
repo: ""
username: ""
version: ""
values: ""
instanceTemplate:
deletionProtection: false
metadata:
annotations: null
labels: null
sleepModeConfig:
deleteAfter: 0
forceSleep: false
forceSleepDuration: 0
ignoreActiveConnections: false
ignoreAll: false
ignoreGroups: ""
ignoreIngresses: false
ignoreResourceNames: ""
ignoreResourceVerbs: ""
ignoreResources: ""
ignoreUserAgents: ""
ignoreVClusters: false
ignoreVerbs: ""
sleepAfter: 0
sleepSchedule: ""
timezone: ""
wakeupSchedule: ""
metadata:
annotations: null
labels: null
objects: ""
pro:
enabled: false
spaceTemplate:
apps:
- name: ""
namespace: ""
parameters: ""
releaseName: ""
version: ""
charts:
- insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
releaseName: ""
releaseNamespace: ""
repoURL: ""
timeout: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
values: ""
version: ""
wait: false
metadata:
annotations: null
labels: null
objects: ""
versions:
- parameters:
- defaultValue: ""
description: ""
invalidation: ""
label: ""
max: 0
min: 0
options:
- ""
placeholder: ""
required: false
section: ""
type: ""
validation: ""
variable: ""
template:
access:
defaultClusterRole: ""
rules:
- clusterRole: ""
devSpaceTeams:
- ""
teams:
- ""
users:
- ""
accessPoint:
ingress:
enabled: false
apps:
- name: ""
namespace: ""
parameters: ""
releaseName: ""
version: ""
charts:
- insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
releaseName: ""
releaseNamespace: ""
repoURL: ""
timeout: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
values: ""
version: ""
wait: false
forwardToken: false
helmRelease:
chart:
name: ""
password: ""
repo: ""
username: ""
version: ""
values: ""
instanceTemplate:
deletionProtection: false
metadata:
annotations: null
labels: null
sleepModeConfig:
deleteAfter: 0
forceSleep: false
forceSleepDuration: 0
ignoreActiveConnections: false
ignoreAll: false
ignoreGroups: ""
ignoreIngresses: false
ignoreResourceNames: ""
ignoreResourceVerbs: ""
ignoreResources: ""
ignoreUserAgents: ""
ignoreVClusters: false
ignoreVerbs: ""
sleepAfter: 0
sleepSchedule: ""
timezone: ""
wakeupSchedule: ""
metadata:
annotations: null
labels: null
objects: ""
pro:
enabled: false
spaceTemplate:
apps:
- name: ""
namespace: ""
parameters: ""
releaseName: ""
version: ""
charts:
- insecureSkipTlsVerify: false
name: ""
password: ""
passwordRef:
projectSecretRef:
key: ""
name: ""
project: ""
releaseName: ""
releaseNamespace: ""
repoURL: ""
timeout: ""
username: ""
usernameRef:
projectSecretRef:
key: ""
name: ""
project: ""
values: ""
version: ""
wait: false
metadata:
annotations: null
labels: null
objects: ""
version: ""
Options
| Flag | Description |
|---|---|
--access string | Access rights for users and teams in JSON format e.g. ‘[{"name": " ", "verbs": [" "," "], "subresources": [" "," "], "users": [" "," "], "teams": [" "," "]}]’ |
--description string | Description of virtual cluster template (default "desc") |
--displayname string | Display name of virtual cluster template |
--dry-run | Outputs the yaml that would be sent as the request payload |
-f, --file string | Update virtual cluster template from a YAML file |
-h, --help | Help for vclustertemplate |
-n, --name string | Name of virtual cluster template |
--owner-team string | Owner team |
--owner-user string | Owner user |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos use
Activate a kube context for the given cluster / space / vcluster / management
Synopsis
The kosmos use command is used to activate a kube context for the given cluster / space / vcluster / management resource. It enables the resource to be used in the current session.
Options
| Flag | Description |
|---|---|
-h, --help | Help for use |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos use cluster
Create a kube context for a specified cluster
Synopsis
The kosmos use cluster command is used to create a kube context for a specified cluster. If the context for the given cluster does not already exist, this command will generate one, allowing you to work with that cluster in your current session.
kosmos use cluster [flags]
Examples
kosmos use cluster <cluster-name>
kosmos use cluster <cluster-name> --fleet <fleet-name>
Options
| Flag | Description |
|---|---|
--disable-direct-cluster-endpoint | When enabled does not use an available direct cluster endpoint to connect to the cluster |
--fleet string | Fleet to use the cluster from |
-h, --help | Help for cluster |
--print | When enabled prints the context to stdout |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos use hostcluster
Create a kube context for a specified host cluster
Synopsis
The kosmos use hostcluster command is used to create a kube context for a specified host cluster.
kosmos use hostcluster [flags]
Examples
kosmos use hostcluster <host-cluster-name>
Options
| Flag | Description |
|---|---|
--disable-direct-cluster-endpoint | When enabled does not use an available direct cluster endpoint to connect to the cluster |
-h, --help | Help for hostcluster |
--print | When enabled prints the context to stdout |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos use management
Create a kube context to the Kosmos Management API
Synopsis
The kosmos use management command is used to create a new Kube context for accessing the Kosmos Management API. This is useful when you want to interact with the management layer of Kosmos resources.
kosmos use management [flags]
Examples
kosmos use management
Options
| Flag | Description |
|---|---|
-h, --help | Help for management |
--print | When enabled prints the context to stdout |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos use vcluster
Create a kube context for a specified virtual cluster
Synopsis
The kosmos use vcluster command is used to create a kube context for interacting with a virtual cluster. This is helpful when you want to manage or access resources within a virtualized Kubernetes environment.
kosmos use vcluster [flags]
Examples
kosmos use vcluster --name <virtual-cluster-name>
kosmos use vcluster --name <virtual-cluster-name> --cluster <cluster-name>
kosmos use vcluster --name <virtual-cluster-name> --cluster <cluster-name> --devspace <devspace-name>
Options
| Flag | Description |
|---|---|
--address string | The local address to start port forwarding under |
--background-proxy | Try to use a background-proxy to access the vCluster. Only works if docker is installed and reachable. (Default true) |
--cluster string | The cluster to use |
--cluster-role string | If specified, vCluster will create the service account if it does not exist and also add a cluster role binding for the given cluster role to it. Requires –service-account to be set |
-d, --devspace string | The DevSpace to use (default "b") |
--disable-direct-cluster-endpoint | When enabled does not use an available direct cluster endpoint to connect to the vcluster |
-h, --help | Help for vcluster |
--insecure | If specified, vCluster will create the kube config with insecure-skip-tls-verify |
--kube-config string | Writes the created kube config to this file (default "./kubeconfig.yaml") |
--kube-config-context-name string | If set, will override the context name of the generated virtual cluster kube config with this name |
--local-port int | The local port to forward the virtual cluster to. If empty, vCluster will use a random unused port |
--name string | Name of virtual cluster to use (default "n") |
--pod string | The pod to connect to |
--print | When enabled prints the context to stdout |
--server string | The server to connect to |
--service-account string | If specified, vCluster will create a service account token to connect to the virtual cluster instead of using the default client cert / key. Service account must exist and can be used as namespace/name. |
--skip-wait | If true, will not wait until the virtual cluster is running |
--token-expiration int | If specified, vCluster will create the service account token for the given duration in seconds. Defaults to eternal |
--update-current | If true updates the current kube config. (Default true) |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos vars
Print predefined variables
Synopsis
The kosmos vars command is used to print predefined variables that can be used within Kosmos, allowing you to work with dynamic and predefined values in your configurations or operations.
Options
| Flag | Description |
|---|---|
-h, --help | Help for vars |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos vars cluster
Print the current cluster’s predefined variables
Synopsis
The kosmos vars cluster command is used to print the current cluster’s predefined variables.
kosmos vars cluster [flags]
Options
| Flag | Description |
|---|---|
-h, --help | Help for cluster |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos vars username
Print the current Kosmos username
Synopsis
The kosmos vars username command is used to print the current Kosmos username.
kosmos vars username [flags]
Options
| Flag | Description |
|---|---|
-h, --help | Help for username |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos wakeup
Wake up a space or virtual cluster
Synopsis
The kosmos wakeup command is used to wake up a space or virtual cluster (vcluster) in the Kosmos environment.
Options
| Flag | Description |
|---|---|
-h, --help | Help for wakeup |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |
kosmos wakeup vcluster
Wake up a virtual cluster
Synopsis
The kosmos wakeup vcluster command is used to wake up a virtual cluster (vcluster) in the Kosmos environment.
kosmos wakeup vcluster [flags]
Examples
kosmos wakeup vcluster --name <virtual-cluster-name>
kosmos wakeup vcluster --name <virtual-cluster-name> --devspace <devspace-name>
Options
| Flag | Description |
|---|---|
-d, --devspace string | Devspace to get virtual cluster from |
-h, --help | Help for vcluster |
-n, --name string | Name of virtual cluster to wake up |
Options inherited from parent commands
| Flag | Description |
|---|---|
--config string | The kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json") |
--debug | Prints the stack trace if an error occurs |
-o, --log-output string | The log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain") |
--silent | Run in silent mode and prevents any kosmos log output except panics & fatals |