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

Commands with description

You can generate a table of all the available commands using kosmos generate table

COMMANDDESCRIPTION
kosmos api-resources [flags]Display supported API resources
kosmos api-versions [flags]Display supported API versions
kosmos completion [bashzsh
kosmos contextConfigure 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 createCreate 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 defaultsManage 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 deleteDelete 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 generateGenerate 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 getGet 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 installInstall Kosmos resources
kosmos install app [flags]Install an app from an app template
kosmos joinJoin a cluster to Kosmos
kosmos join cluster [flags]Join a cluster to Kosmos
kosmos listList 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 resetReset configuration
kosmos reset password [flags]Reset password of a user
kosmos setConfigure Kosmos environment settings
kosmos set secret [flags]Set key and value of a project / shared secret
kosmos shareShare cluster resources
kosmos share vcluster [flags]Share a virtual cluster with another Kosmos user or team
kosmos sleepPut 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 uninstallUninstall Kosmos resources
kosmos uninstall app [flags]Uninstall an app
kosmos updateUpdate 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 useActivate 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 varsPrint predefined variables
kosmos vars cluster [flags]Print the current cluster’s predefined variables
kosmos vars username [flags]Print the current Kosmos username
kosmos wakeupWake 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

FlagDescription
-h, --helpHelp for api-resources

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for api-versions

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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/kosmos
    
    
    
  • MacOS:

    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

FlagDescription
-h, --helpHelp for completion

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for context

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for delete
-n, --name stringName of the context in kubeconfig

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for get
-n, --name stringName of the context

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for list

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--devspace stringDevSpace of virtual cluster
-h, --helpHelp for set
--virtualcluster stringName of virtual cluster

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for use
--name stringName of the context entry in kubeconfig

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for create

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--config-deleteondetachment(Default true)
--description stringDescription of AKS cluster
--displayname stringDisplay name of AKS cluster
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringCreate AKS cluster from a YAML file
--fleet stringFleet of AKS cluster
-h, --helpHelp for aks
--name stringName of AKS cluster
--skeletonOutputs skeleton YAML that can be used with the –file flag

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--client-id stringClient ID for AKS OIDC Connect
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringCreate AKS OIDC connect from a YAML file
--fleet stringFleet of AKS OIDC connect
-h, --helpHelp for aksoidcconnect
--jwt-claims stringJWT Claims in JSON format e.g. ‘{"aud": " ", "iss": " ", "sub": " "}’
--name stringName of AKS OIDC connect
--skeletonOutputs skeleton YAML that can be used with the –file flag
--subscription-id stringSubscription id for AKS OIDC connect
--tenant-id stringTenant ID for AKS OIDC connect

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--clusters stringsClusters the app can be installed in (comma separated)
--description stringDescription of app
--displayname stringDisplay name of app
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringCreate app from a YAML file
-h, --helpHelp for app
--name stringName of app
--owner-team stringOwner team
--owner-user stringOwner user
--skeletonOutputs skeleton YAML that can be used with the –file flag

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--access stringAccess rights for users and teams in JSON format e.g. ‘[{"name": " ", "verbs": [" "," "], "subresources": [" "," "], "users": [" "," "], "teams": [" "," "]}]’
--clusters stringsClusters the template should be applied on (comma separated)
--description stringDescription of cluster role template
--displayname stringDisplay name of cluster role template
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringCreate cluster role template from a YAML file
-h, --helpHelp for clusterroletemplate
--name stringName of cluster role template
--owner-team stringOwner team
--owner-user stringOwner user
--skeletonOutputs skeleton YAML that can be used with the –file flag

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--access stringAccess rights for users and teams in JSON format e.g. ‘[{"name": " ", "verbs": [" "," "], "subresources": [" "," "], "users": [" "," "], "teams": [" "," "]}]’
--clusters stringsClusters the template should be applied on (comma separated)
--description stringDescription of devspace cluster access
--devspace stringDevspace of devspace cluster access
--displayname stringDisplay name of devspace cluster access
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringCreate devspace cluster access from a YAML file
-h, --helpHelp for devspaceclusteraccess
--name stringName of devspace cluster access
--owner-team stringOwner team
--owner-user stringOwner user
--skeletonOutputs skeleton YAML that can be used with the –file flag

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--description stringDescription of devspace role
--devspace stringDevspace of devspace role
--displayname stringDisplay name of devspace role
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringCreate devspace role from a YAML file
-h, --helpHelp for devspacerole
--name stringName of devspace role
--rules stringAccess rules associated with devspace role in JSON format e.g. ‘[{"resources": [" "," "], "verbs": [" "," "]}]’
--skeletonOutputs skeleton YAML that can be used with the –file flag

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--description stringDescription of devspace secret
--devspace stringDevspace of devspace secret
--displayname stringDisplay name of devspace secret
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringCreate devspace secret from a YAML file
-h, --helpHelp for devspacesecret
--name stringName of devspace secret
--skeletonOutputs skeleton YAML that can be used with the –file flag

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--access stringAccess rights for users and teams in JSON format e.g. ‘[{"name": " ", "verbs": [" "," "], "subresources": [" "," "], "users": [" "," "], "teams": [" "," "]}]’
--clusterroles stringsNames of cluster roles to be assigned to the users (comma separated)
--description stringDescription of devspace team
--devspace stringDevspace of devspace team
--displayname stringDisplay name of devspace team
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringCreate devspace team from a YAML file
--groups stringsGroups that belong to the devspace team (comma separated)
-h, --helpHelp for devspaceteam
--name stringName of devspace team
--owner-team stringOwner team
--owner-user stringOwner user
--skeletonOutputs skeleton YAML that can be used with the –file flag
--username stringUsername of devspace team
--users stringsUsers that belong to the devspace team (comma separated)

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--config-deleteondetachmentDelete cluster when detached from kosmos. Required if import is false. (Default true)
--config-kosmosrolearn stringARN of the role to manage the EKS cluster
--config-kubernetesversion stringRequired if imported is false
--description stringDescription of EKS cluster
--displayname stringDisplay name of EKS cluster
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringCreate EKS cluster from a YAML file
--fleet stringFleet of EKS cluster
-h, --helpHelp for eks
--name stringName of EKS cluster
--skeletonOutputs skeleton YAML that can be used with the –file flag

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringCreate EKS OIDC connect from a YAML file
--fleet stringFleet of EKS OIDC connect
-h, --helpHelp for eksoidcconnect
--jwt-claims stringJWT claims in JSON format e.g. ‘{"aud": " ", "iss": " ", "sub": " "}’
--kosmos-role-arn stringARN of the role used to manage the EKS cluster
--name stringName of EKS OIDC connect
--region stringRegion of the cluster
--skeletonOutputs skeleton YAML that can be used with the –file flag

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--access stringAccess rights for users and teams in JSON format e.g. ‘[{"name": " ", "verbs": [" "," "], "subresources": [" "," "], "users": [" "," "], "teams": [" "," "]}]’
--clusters stringsClusters the template should be applied on (comma separated)
--description stringDescription of fleet cluster access
--displayname stringDisplay name of fleet cluster access
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringCreate fleet cluster access from a YAML file
--fleet stringFleet of fleet cluster access
-h, --helpHelp for fleetclusteraccess
--name stringName of fleet cluster access
--owner-team stringOwner team
--owner-user stringOwner user
--skeletonOutputs skeleton YAML that can be used with the –file flag

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--clusters stringsclusters this template applies on (comma separated)
--description stringDescription of fleet cluster role template (default "desc")
--displayname stringDisplay Name of fleet cluster role template
--dry-runOutputs yaml template for fleetclusterroletemplate
-f, --file stringCreate fleet cluster role template from a YAML file
--fleet stringFleet of fleet cluster role template
-h, --helpHelp for fleetclusterroletemplate
--managementtrue if the role template should be in management instance
-n, --name stringName of fleet cluster role template
--owning_team stringOwning team of the fleet
--owning_user stringOwning user of the fleet
--skeletonOutputs skeleton YAML that can be used with the –file flag

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--description stringDescription of fleet role
--dry-runOutputs yaml template for fleetrole
-f, --file stringCreate fleet role from a YAML file
--fleet stringName of owning fleet of fleet role
-h, --helpHelp for fleetrole
--name stringName of fleet role
--rules stringToStringFleet role rules. See examples for more info (default [])
--skeletonOutputs skeleton YAML that can be used with the –file flag

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--description stringDescription of fleet secret
--displayname stringDisplay name of fleet secret
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringCreate fleet secret from a YAML file
--fleet stringFleet of fleet secret
-h, --helpHelp for fleetsecret
--name stringName of fleet secret
--secretname stringName of secret in connected clusters
--secretnamespace stringNamespace of secret in connected clusters
--skeletonOutputs skeleton YAML that can be used with the –file flag
--vaultmountpath stringVault mount path for fleet secret
--vaultsecretpath stringVault secret path for fleet secret

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--description stringDescription of fleet space template (default "desc")
--displayname stringDisplay Name of fleet space template
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringCreate fleet space template from a YAML file
--fleet stringFleet of fleet space template
-h, --helpHelp for fleetspacetemplate
-n, --name stringName of fleet space template
--owner-team stringOwner team
--owner-user stringOwner user
--skeletonOutputs skeleton YAML that can be used with the –file flag

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--access stringAccess rights for users and teams in JSON format e.g. ‘[{"name": " ", "verbs": [" "," "], "subresources": [" "," "], "users": [" "," "], "teams": [" "," "]}]’
--clusterroles stringsNames of cluster roles to be assigned to the users (comma separated)
--description stringDescription of fleet team
--displayname stringDisplay name of fleet team
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringCreate fleet team from a YAML file
--fleet stringFleet of fleet team
--groups stringsGroups that belong to fleet team (comma separated)
-h, --helpHelp for fleetteam
--name stringName of fleet team
--owner-team stringOwner team
--owner-user stringOwner user
--skeletonOutputs skeleton YAML that can be used with the –file flag
--username stringUsername of fleet team
--users stringsUsers that belong to fleet team (comma separated)

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--cluster-region stringRegion of generic cluster
--description stringDescription of generic cluster
--displayname stringDisplay name of generic cluster
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringCreate generic cluster from a YAML file
--fleet stringFleet of generic cluster
-h, --helpHelp for genericcluster
--kubeconfig stringKubernetes config used to connect the cluster
--kubernetes-version stringKubernetes version of generic cluster
--name stringName of generic cluster
--owner stringOwner of generic cluster
--skeletonOutputs skeleton YAML that can be used with the –file flag

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--config-deleteondetachment(Default true)
--description stringDescription of GKE cluster
--displayname stringDisplay name of GKE cluster
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringCreate GKE cluster from a YAML file
--fleet stringFleet of GKE cluster
-h, --helpHelp for gke
--name stringName of GKE cluster
--skeletonOutputs skeleton YAML that can be used with the –file flag

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringCreate GKE OIDC connect from a YAML file
--fleet stringFleet of GKE OIDC connect
-h, --helpHelp for gkeoidcconnect
--jwt-claims stringJWT claims in JSON format e.g. ‘{"aud": " ", "iss": " ", "sub": " "}’
--name stringName of GKE OIDC connect
--project-number stringProject number
--service-account stringService account for GKE OIDC connect
--skeletonOutputs skeleton YAML that can be used with the –file flag
--workload-identity-pool-id stringWorkload identity pool ID
--workload-identity-provider-id stringWorkload identity provider ID

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--config-deleteondetachmentDelete cluster when detached from kosmos. Required if import is false. (Default true)
--config-kosmosrolearn stringARN of the role to manage the MKS cluster.
--config-kubernetesversion stringRequired if imported is false
--description stringDescription of MKS cluster
--displayname stringDisplay name of MKS cluster
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringCreate MKS cluster from a YAML file
--fleet stringFleet of MKS cluster
-h, --helpHelp for mks
--name stringName of MKS cluster
--skeletonOutputs skeleton YAML that can be used with the –file flag

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringCreate MKS OIDC connect from a YAML file
--fleet stringFleet of MKS OIDC connect
-h, --helpHelp for mksoidcconnect
--jwt-claims stringJWT claims in JSON format e.g. ‘{"aud": " ", "iss": " ", "sub": " "}’
--kosmos-role-arn stringARN of the role used to manage the MKS cluster
--name stringName of MKS OIDC connect
--region stringRegion of cluster
--skeletonOutputs skeleton YAML that can be used with the –file flag

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--address stringAddress of vault configuration
--auth-secret-key stringAuth secret key of vault configuration
--auth-secret-name stringAuth secret name of vault configuration
--auth-token stringAuth token of vault configuration
--devspace stringDevSpace of vault configuration
--dry-runOutputs the yaml that would be sent as the request payload
--enabledWhether vault configuration is enabled
-f, --file stringCreate vault configuration from a YAML file
--fleet stringFleet of vault configuration
-h, --helpHelp for vaultconfiguration
--name stringName of vault configuration
--skeletonOutputs skeleton YAML that can be used with the –file flag
--sync-interval stringSync interval of vault configuration

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--annotations stringsComma separated annotations to apply to the virtualcluster
--cluster stringThe cluster to create the virtual cluster in
--create-contextIf Kosmos should create a kube context for the space. (Default true)
--description stringThe description to show in the UI for this virtual cluster
-d, --devspace stringThe DevSpace to use (default "b")
--disable-direct-cluster-endpointWhen enabled does not use an available direct cluster endpoint to connect to the vcluster
--display-name stringThe display name to show in the UI for this virtual cluster
--dry-runOutputs yaml template for virtual cluster
-f, --file stringCreate virtual cluster from a YAML file
-h, --helpHelp for vcluster
-l, --labels stringsComma separated labels to apply to the virtualcluster
--link stringsLabeled Links to annotate the object with.
-n, --name stringName of virtual cluster
--parameters stringThe file where the parameter values for the apps are specified
--printIf enabled, prints the context to the console
--recreateIf enabled and there already exists a virtual cluster with this name, Kosmos will delete it first
--set stringsAllows specific template parameters to be set. E.g. –set myParameter=myValue
--skeletonOutputs skeleton YAML that can be used with the –file flag
--skip-waitIf true, will not wait until the virtual cluster is running
--space stringThe space to create the virtual cluster in
--switch-contextIf kosmos should switch the current context to the new context. (Default true)
--team stringThe team to create the space for
--template stringThe virtual cluster template to use to create the virtual cluster
--updateIf enabled and a virtual cluster already exists, will update the template, version and parameters
--useIf kosmos should use the virtual cluster if its already there
--user stringThe user to create the space for
--version stringThe template version to use

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--access stringAccess rights for users and teams in JSON format e.g. ‘[{"name": " ", "verbs": [" "," "], "subresources": [" "," "], "users": [" "," "], "teams": [" "," "]}]’
--description stringDescription of virtual cluster template (default "desc")
--displayname stringDisplay name of virtual cluster template
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringCreate virtual cluster template from a YAML file
-h, --helpHelp for vclustertemplate
-n, --name stringName of virtual cluster template
--owner-team stringOwner team
--owner-user stringOwner user
--skeletonOutputs skeleton YAML that can be used with the –file flag

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for defaults

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for get

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for set

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for view

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for delete

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet to delete the AKS cluster from
-h, --helpHelp for aks
-n, --name stringName of AKS cluster

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet of the AKS OIDC connect
-h, --helpHelp for aksoidcconnect
-n, --name stringName of AKS OIDC connect

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for app
-n, --name stringName of app

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for clusterroletemplate
-n, --name stringName of cluster role template

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--devspace stringDevspace to delete the devspace cluster access from
-h, --helpHelp for devspaceclusteraccess
-n, --name stringName of devspace cluster access

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--devspace stringDevspace to delete the devspace role from
-h, --helpHelp for devspacerole
-n, --name stringName of devspace role

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--devspace stringDevspace to delete the devspace secret from
-h, --helpHelp for devspacesecret
-n, --name stringName of devspace secret

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--devspace stringDevspace to delete the devspace team from
-h, --helpHelp for devspaceteam
-n, --name stringName of devspace team

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet to delete the EKS cluster from
-h, --helpHelp for eks
-n, --name stringName of EKS cluster

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet of the EKS OIDC connect
-h, --helpHelp for eksoidcconnect
-n, --name stringName of EKS OIDC connect

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet name to delete the fleet cluster access from
-h, --helpHelp for fleetclusteraccess
-n, --name stringName of fleet cluster access

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet of fleet cluster role template
-h, --helpHelp for fleetclusterroletemplate
-n, --name stringName of fleet cluster role template

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet to delete the fleet role from
-h, --helpHelp for fleetrole
--name stringName of fleet role

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet to delete the fleet secret from
-h, --helpHelp for fleetsecret
-n, --name stringName of fleet secret

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet name to delete the fleet space template from
-h, --helpHelp for fleetspacetemplate
-n, --name stringName of fleet space template

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet to delete the fleet team from
-h, --helpHelp for fleetteam
--name stringName of fleet team

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet to delete the generic cluster from
-h, --helpHelp for genericcluster
-n, --name stringName of generic cluster

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet to delete the GKE cluster from
-h, --helpHelp for gke
-n, --name stringName of GKE cluster

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet of the GKE OIDC connect
-h, --helpHelp for gkeoidcconnect
-n, --name stringName of GKE OIDC connect

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet to delete the MKS cluster from
-h, --helpHelp for mks
-n, --name stringName of MKS cluster

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet of the MKS OIDC connect
-h, --helpHelp for mksoidcconnect
-n, --name stringName of MKS OIDC connect

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--devspace stringDevspace associated with vault configuration
--fleet stringFleet associated with vault configuration
-h, --helpHelp for vaultconfiguration
-n, --name stringName of vault configuration

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--delete-contextIf the corresponding kube context should be deleted if there is any. (Default true)
-d, --devspace stringDevspace to get virtual cluster from
-h, --helpHelp for vcluster
-n, --name stringName of virtual cluster
--waitTermination of this command waits for space to be deleted. Without the flag delete-space, this flag has no effect.

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for vclustertemplate
-n, --name stringName of virtual cluster template

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for disconnect

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for generate

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for admin-kube-config
--namespace stringThe namespace to generate the service account in. The namespace will be created if it does not exist (default "loft")
--service-account stringThe service account name to create (default "loft-admin")

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for doc
--path stringThe path to write the generated documentation to (default "./docs")

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for table

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for get

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet to get the AKS cluster from
-h, --helpHelp for aks
-n, --name stringName of AKS cluster

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet to get the AKS OIDC connect from
-h, --helpHelp for aksoidcconnect
-n, --name stringName of AKS OIDC connect

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for app
-n, --name stringName of app

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--devspace stringdevspace associated with application role
--fleet stringfleet associated with application role
-h, --helpHelp for applicationrole
--name stringName of application role

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for clusteraccesskey
--name stringName of cluster to retrieve access key for

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for clusterroletemplate
-n, --name stringName of cluster role template

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for currentuser

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for devspace
--name stringName of devspace

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for devspaceallowedcluster
-n, --name stringName of devspace allowed cluster

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--devspace stringDevspace to get the devspace cluster access from
-h, --helpHelp for devspaceclusteraccess
-n, --name stringName of devspace cluster access

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--devspace stringDevspace to get the devspace role from
-h, --helpHelp for devspacerole
-n, --name stringName of devspace role

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--devspace stringDevspace to get the devspace secret from
-h, --helpHelp for devspacesecret
-n, --name stringName of devspace secret

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--devspace stringDevspace to get the devspace team from
-h, --helpHelp for devspaceteam
-n, --name stringName of devspace team

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet to get the EKS cluster from
-h, --helpHelp for eks
-n, --name stringName of EKS cluster

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet to get the EKS OIDC connect from
-h, --helpHelp for eksoidcconnect
-n, --name stringName of EKS OIDC connect

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for fleet
--name stringName of fleet

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet name to get the fleet cluster access from
-h, --helpHelp for fleetclusteraccess
-n, --name stringName of fleet cluster access

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet owning this fleet cluster role template
-h, --helpHelp for fleetclusterroletemplate
-n, --name stringName of fleet cluster role template

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet to get the fleet role from
-h, --helpHelp for fleetrole
--name stringName of fleet role

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet to get the fleet secret from
-h, --helpHelp for fleetsecret
-n, --name stringName of fleet secret

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet name to get the fleet space template from
-h, --helpHelp for fleetspacetemplate
-n, --name stringName of fleet space template

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet to get the fleet team from
-h, --helpHelp for fleetteam
--name stringName of fleet team

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet to get the generic cluster from
-h, --helpHelp for genericcluster
-n, --name stringName of generic cluster

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet to get the GKE cluster from
-h, --helpHelp for gke
-n, --name stringName of GKE cluster

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet to get the GKE OIDC connect from
-h, --helpHelp for gkeoidcconnect
-n, --name stringName of GKE OIDC connect

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet to get the MKS cluster from
-h, --helpHelp for mks
-n, --name stringName of MKS cluster

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet to get the MKS OIDC connect from
-h, --helpHelp for mksoidcconnect
-n, --name stringName of MKS OIDC connect

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-a, --allDisplay all secret keys
-h, --helpHelp for secret
--name stringName of secret
-n, --namespace stringThe namespace in the Kosmos cluster to read the secret from. If omitted will use the namespace where Kosmos is installed in
-p, --project stringThe project to read the project secret from. (default "b")

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for team
-n, --name stringName of team

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--devspace stringDevspace associated with vault configuration
--fleet stringFleet associated with vault configuration
-h, --helpHelp for vaultconfiguration
--name stringName of vault configuration

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--devspace stringDevSpace to get the virtual cluster from
-h, --helpHelp for vcluster
-n, --name stringName of virtual cluster

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for vclustertemplate
-n, --name stringName of virtual cluster template

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for info

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for install

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--devspace stringtarget devspace for the app
--dry-runOutputs the yaml that would be sent as the request payload
--fleet stringtarget fleet for the app
-h, --helpHelp for app
--name stringName of the app
--parameter-file stringparameter file(yaml) for the app
--release-name stringrelease name
--skeletonOutputs skeleton YAML that can be used with the –file flag
--target-cluster stringtarget cluster name
--target-namespace stringNamespace. Default: kosmos-system
--version stringVersion of the app template

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for join

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--agent-replicas intSets the number of agent replicas in Helm (default 2)
--context stringThe kube context to use for installation
--display-name stringThe display name to show in the UI for this cluster
--fleet stringThe fleet to get cluster details from
--helm-chart-path stringThe agent chart to deploy
--helm-chart-version stringThe agent chart version to deploy
--helm-set stringArrayExtra helm values for the agent chart
--helm-values stringArrayExtra helm values for the agent chart
-h, --helpHelp for cluster
--insecureIf true, deploys the agent in insecure mode
--namespace stringThe namespace to generate the service account in. The namespace will be created if it does not exist (default "vcluster-platform")
--previous-methodIf true, will use the previous, non-experimental cluster enrollment feature
--service-account stringThe service account name to create (default "loft-admin")
--waitIf true, will wait until the cluster is initialized

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for list

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for accesskeys
--namespace stringNamespace to get the access keys from

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-A, --allDisplay AKS clusters from all fleets
--fleet stringFleet to get the AKS clusters from
-h, --helpHelp for aks

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-A, --allDisplay AKS OIDC connects from all fleets
--fleet stringFleet to get the AKS OIDC connects from
-h, --helpHelp for aksoidcconnects

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--devspace stringdevspace associated with application role
--fleet stringfleet associated with application role
-h, --helpHelp for applicationroles

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for apps

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for clusterroletemplates

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-A, --allDisplay clusters from all fleets
--distribution stringDistribution of cluster. Can be either generic, eks, mks, or gke
--fleet stringFleet to get the clusters from
-h, --helpHelp for clusters

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for devspaceallowedclusters

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-A, --allDisplay devspace cluster accesses from all devspaces
--devspace stringDevspace to get the devspace cluster accesses from
-h, --helpHelp for devspaceclusteraccesses

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-A, --allDisplay devspace roles from all devspaces
--devspace stringDevspace to get the devspace roles from
-h, --helpHelp for devspaceroles

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for devspaces

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-A, --allDisplay devspace secrets from all devspaces
--devspace stringDevspace to get the devspace secrets from
-h, --helpHelp for devspacesecrets

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-A, --allDisplay devspace teams from all devspaces
--devspace stringDevspace to get the devspace teams from
-h, --helpHelp for devspaceteams

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-A, --allDisplay EKS clusters from all fleets
--fleet stringFleet to get the EKS clusters from
-h, --helpHelp for eks

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-A, --allDisplay EKS OIDC connects from all fleets
--fleet stringFleet to get the EKS OIDC connects from
-h, --helpHelp for eksoidcconnects

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-A, --allDisplay fleet cluster accesses from all fleets
--fleet stringFleet to list the fleet cluster accesses from
-h, --helpHelp for fleetclusteraccesses

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet to list fleet cluster role templates from
-h, --helpHelp for fleetclusterroletemplates

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-A, --allDisplay fleet roles from all fleets
--fleet stringFleet to list the fleet roles from
-h, --helpHelp for fleetroles

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for fleets

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-A, --allDisplay fleet secrets from all fleets
--fleet stringFleet to get the fleet secrets from
-h, --helpHelp for fleetsecrets

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--fleet stringFleet to list the fleet space templates from
-h, --helpHelp for fleetspacetemplates

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-A, --allDisplay fleet teams from all fleets
--fleet stringFleet to get the fleet teams from
-h, --helpHelp for fleetteams

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-A, --allDisplay generic clusters from all fleets
--fleet stringFleet to get the generic clusters from
-h, --helpHelp for genericclusters

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-A, --allDisplay GKE clusters from all fleets
--fleet stringFleet to get the GKE clusters from
-h, --helpHelp for gke

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-A, --allDisplay GKE OIDC connects from all fleets
--fleet stringFleet to get the GKE OIDC connects from
-h, --helpHelp for gkeoidcconnects

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for hostclusters

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-A, --allDisplay MKS clusters from all fleets
--fleet stringFleet to get the MKS clusters from
-h, --helpHelp for mks

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-A, --allDisplay MKS OIDC connects from all fleets
--fleet stringFleet to get the MKS OIDC connects from
-h, --helpHelp for mksoidcconnects

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--devspace stringDevspace to get the quotas from
-h, --helpHelp for quotas

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-a, --allDisplay global and project secrets. May be used with the –project flag to display global secrets and a subset of project secrets
--all-projectsDisplay project secrets for all projects.
-h, --helpHelp for secrets
-n, --namespace stringThe namespace in the Kosmos cluster to read global secrets from. If omitted will query all accessible global secrets
-p, --project stringArrayThe project(s) to read project secrets from. If omitted will list global secrets

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for teams

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-A, --alldisplay vault configurations from all devspaces
--devspace stringdevspace associated with vault configuration
--fleet stringfleet associated with vault configuration
-h, --helpHelp for vaultconfigurations

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-A, --allDisplay virtual clusters from all devspaces
--devspace stringDevspace to get the virtual cluster from
-h, --helpHelp for vclusters
--show-legacyIf true, will always show the legacy virtual clusters as well

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for vclustertemplates

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--access-key stringThe access key to use
--docker-loginIf true, will log into the docker image registries the user has image pull secrets for. (Default true)
-h, --helpHelp for login
--insecureAllow login into an insecure Kosmos instance. (Default true)

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for logout

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for reset

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--createCreates the user if it does not exist
--forceIf user had no password will create one
-h, --helpHelp for password
--password stringThe new password to use
--user stringThe name of the user to reset the password (default "admin")

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for set

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-f, --file stringPath to file containing secret key
-h, --helpHelp for secret
-n, --namespace stringNamespace in Kosmos cluster to create secret in. If omitted will use the namespace where Kosmos is installed.
-p, --project stringProject to create secret in. (default "b")
-v, --value stringValue to set for secret key

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for share

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--cluster stringCluster to use
--cluster-role stringCluster role which is assigned to user or team for that space (default "loft-cluster-space-admin")
--devspace stringDevspace to get virtual cluster from
-h, --helpHelp for vcluster
-n, --name stringName of virtual cluster
--team stringTeam to share the space with. The team needs to have access to the cluster
--user stringUser to share the space with. The user needs to have access to the cluster

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for sleep

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-d, --devspace stringDevspace to get virtual cluster from
-h, --helpHelp for vcluster
-n, --name stringName of virtual cluster to put to sleep
--prevent-wakeup kosmos wakeup vclusterThe 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

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--direct-cluster-endpointWhen enabled prints a direct cluster endpoint token
-h, --helpHelp for token
--project stringThe project containing the virtual cluster
--virtual-cluster stringThe virtual cluster

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for uninstall

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--devspace stringtarget devspace of the app
--dry-runOutputs the yaml that would be sent as the request payload
--fleet stringtarget fleet of the app
-h, --helpHelp for app
--name stringName of the app template to install from
--parameter-file stringparameter file(yaml) for the app
--release-name stringrelease name
--skeletonOutputs skeleton YAML that can be used with the –file flag
--target-cluster stringtarget cluster name
--target-namespace stringNamespace. Default: kosmos-system
--version stringVersion of the app template

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for update

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--config-deleteondetachment(Default true)
--description stringDescription of AKS cluster
--displayname stringDisplay name of AKS cluster
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringUpdate AKS cluster from a YAML file
--fleet stringFleet of AKS cluster
-h, --helpHelp for aks
--name stringName of AKS cluster
--replaceIf enabled, replaces an existing AKS cluster

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--client-id stringClient ID for AKS OIDC Connect
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringUpdate AKS OIDC connect from a YAML file
--fleet stringFleet of AKS OIDC connect
-h, --helpHelp for aksoidcconnect
--jwt-claims stringJWT Claims in JSON format e.g. ‘{"aud": " ", "iss": " ", "sub": " "}’
--name stringName of AKS OIDC connect
--subscription-id stringSubscription id for AKS OIDC connect
--tenant-id stringTenant ID for AKS OIDC connect

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--clusters stringsClusters the app can be installed in (comma separated)
--description stringDescription of app
--displayname stringDisplay name of app
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringUpdate app from a YAML file
-h, --helpHelp for app
--name stringName of app
--owner-team stringOwner team
--owner-user stringOwner user

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--devspace stringdevspace associated with application role
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringUpdate application role from a YAML file
--fleet stringfleet associated with application role
-h, --helpHelp for applicationrole
--name stringname of appllication role
--subject-file stringsubject file defines users and teams only
--teams stringsList of team (group) subjects
--users stringsList of user subjects

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--access stringAccess rights for users and teams in JSON format e.g. ‘[{"name": " ", "verbs": [" "," "], "subresources": [" "," "], "users": [" "," "], "teams": [" "," "]}]’
--clusters stringsClusters the template should be applied on (comma separated)
--description stringDescription of cluster role template
--displayname stringDisplay name of cluster role template
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringUpdate cluster role template from a YAML file
-h, --helpHelp for clusterroletemplate
--name stringName of cluster role template
--owner-team stringOwner team
--owner-user stringOwner user

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--allowed-clusters stringsClusters allowed in devspace (comma separated)
--allowed-templates stringsTemplates allowed in devspace (comma separated)
--default-devspace-role stringDefault Role for devspace
--description stringDescription of devspace
--displayname stringDisplay name of devspace
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringUpdate devspace from a YAML file
-h, --helpHelp for devspace
--name stringName of devspace
--owner-team stringOwner team
--owner-user stringOwner user
--users stringsUsers of devspace (comma separated)

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--access stringAccess rights for users and teams in JSON format e.g. ‘[{"name": " ", "verbs": [" "," "], "subresources": [" "," "], "users": [" "," "], "teams": [" "," "]}]’
--clusters stringsClusters the template should be applied on (comma separated)
--description stringDescription of devspace cluster access
--devspace stringDevspace of devspace cluster access
--displayname stringDisplay name of devspace cluster access
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringUpdate devspace cluster access from a YAML file
-h, --helpHelp for devspaceclusteraccess
--name stringName of devspace cluster access
--owner-team stringOwner team
--owner-user stringOwner user

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--description stringDescription of devspace role
--devspace stringDevspace of devspace role
--displayname stringDisplay name of devspace role
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringUpdate devspace role from a YAML file
-h, --helpHelp for devspacerole
--name stringName of devspace role
--rules stringAccess rules associated with devspace role in JSON format e.g. ‘[{"resources": [" "," "], "verbs": [" "," "]}]’

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--description stringDescription of devspace secret
--devspace stringDevspace of devspace secret
--displayname stringDisplay name of devspace secret
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringUpdate devspace secret from a YAML file
-h, --helpHelp for devspacesecret
--name stringName of devspace secret

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--access stringAccess rights for users and teams in JSON format e.g. ‘[{"name": " ", "verbs": [" "," "], "subresources": [" "," "], "users": [" "," "], "teams": [" "," "]}]’
--clusterroles stringsNames of cluster roles to be assigned to the users (comma separated)
--description stringDescription of devspace team
--devspace stringDevspace of devspace team
--displayname stringDisplay name of devspace team
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringUpdate devspace team from a YAML file
--groups stringsGroups that belong to the devspace team (comma separated)
-h, --helpHelp for devspaceteam
--name stringName of devspace team
--owner-team stringOwner team
--owner-user stringOwner user
--username stringUsername of devspace team
--users stringsUsers that belong to the devspace team (comma separated)

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--config-deleteondetachmentDelete cluster when detached from kosmos. Required if import is false. (Default true)
--config-kosmosrolearn stringARN of the role to manage the EKS cluster
--config-kubernetesversion stringRequired if imported is false
--description stringDescription of EKS cluster
--displayname stringDisplay name of EKS cluster
--dry-runIf enabled, doesn’t perform update operation on server
-f, --file stringUpdate EKS cluster from a YAML file
--fleet stringFleet of EKS cluster
-h, --helpHelp for eks
--name stringName of EKS cluster
--replaceIf enabled, replaces an existing eks cluster

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringUpdate EKS OIDC connect from a YAML file
--fleet stringFleet of EKS OIDC connect
-h, --helpHelp for eksoidcconnect
--jwt-claims stringJWT claims in JSON format e.g. ‘{"aud": " ", "iss": " ", "sub": " "}’
--kosmos-role-arn stringARN of the role used to manage the EKS cluster
--name stringName of EKS OIDC connect
--region stringRegion of the cluster

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--description stringDescription of fleet
--displayname stringDisplay name of fleet
-f, --file stringUpdate fleet from a YAML file
-h, --helpHelp for fleet
--name stringName of fleet
--owning_team stringOwning team of fleet
--owning_user stringOwning user of fleet
--users stringsList of users assigned to fleet

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--access stringAccess rights for users and teams in JSON format e.g. ‘[{"name": " ", "verbs": [" "," "], "subresources": [" "," "], "users": [" "," "], "teams": [" "," "]}]’
--clusters stringsClusters the template should be applied on (comma separated)
--description stringDescription of fleet cluster access
--displayname stringDisplay name of fleet cluster access
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringUpdate fleet cluster access from a YAML file
--fleet stringFleet of fleet cluster access
-h, --helpHelp for fleetclusteraccess
--name stringName of fleet cluster access
--owner-team stringOwner team
--owner-user stringOwner user

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--clusters stringsclusters this template applies on (comma separated)
--description stringDescription of fleet cluster role template (default "desc")
--displayname stringDisplay Name of fleet cluster role template
--dry-runOutputs yaml template for fleet cluster role template
-f, --file stringUpdate fleet cluster role template from a YAML file
--fleet stringFleet of fleet cluster role template
-h, --helpHelp for fleetclusterroletemplate
--managementtrue if the role template should be in management instance
-n, --name stringName of fleet cluster role template
--owning_team stringOwning team of the fleet
--owning_user stringOwning user of the fleet

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--description stringDescription of fleet role
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringUpdate fleet role from a YAML file
--fleet stringName of owning fleet of fleet role
-h, --helpHelp for fleetrole
--name stringName of fleet role
--rules stringToStringFleet role rules. See examples for more info (default [])

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--description stringDescription of fleet secret
--displayname stringDisplay name of fleet secret
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringUpdate fleet secret from a YAML file
--fleet stringFleet of fleet secret
-h, --helpHelp for fleetsecret
--name stringName of fleet secret
--secretname stringName of secret in connected clusters
--secretnamespace stringNamespace of secret in connected clusters
--vaultmountpath stringVault mount path for fleet secret
--vaultsecretpath stringVault secret path for fleet secret

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--description stringDescription of fleet space template (default "desc")
--displayname stringDisplay Name of fleet space template
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringUpdate fleet space template from a YAML file
--fleet stringFleet of fleet space template
-h, --helpHelp for fleetspacetemplate
-n, --name stringName of fleet space template
--owner-team stringOwner team
--owner-user stringOwner user

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--access stringAccess rights for users and teams in JSON format e.g. ‘[{"name": " ", "verbs": [" "," "], "subresources": [" "," "], "users": [" "," "], "teams": [" "," "]}]’
--clusterroles stringsNames of cluster roles to be assigned to the users (comma separated)
--description stringDescription of fleet team
--displayname stringDisplay name of fleet team
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringUpdate fleet team from a YAML file
--fleet stringFleet of fleet team
--groups stringsGroups that belong to fleet team (comma separated)
-h, --helpHelp for fleetteam
--name stringName of fleet team
--owner-team stringOwner team
--owner-user stringOwner user
--username stringUsername of fleet team
--users stringsUsers that belong to fleet team (comma separated)

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--cluster-region stringRegion of generic cluster
--description stringDescription of generic cluster
--displayname stringDisplay name of generic cluster
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringUpdate generic cluster from a YAML file
--fleet stringFleet of generic cluster
-h, --helpHelp for genericcluster
--kubeconfig stringKubernetes config used to connect the cluster
--kubernetes-version stringKubernetes version of generic cluster
--name stringName of generic cluster
--owner stringOwner of generic cluster

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--config-deleteondetachment(Default true)
--description stringDescription of GKE cluster
--displayname stringDisplay name of GKE cluster
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringUpdate GKE cluster from a YAML file
--fleet stringFleet of GKE cluster
-h, --helpHelp for gke
--name stringName of GKE cluster
--replaceIf enabled, replaces an existing GKE cluster

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringUpdate GKE OIDC connect from a YAML file
--fleet stringFleet of GKE OIDC connect
-h, --helpHelp for gkeoidcconnect
--jwt-claims stringJWT claims in JSON format e.g. ‘{"aud": " ", "iss": " ", "sub": " "}’
--name stringName of GKE OIDC connect
--project-number stringProject number
--service-account stringService account for GKE OIDC connect
--workload-identity-pool-id stringWorkload identity pool ID
--workload-identity-provider-id stringWorkload identity provider ID

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--config-deleteondetachmentDelete cluster when detached from kosmos. Required if import is false. (Default true)
--config-kosmosrolearn stringARN of the role to manage the MKS cluster.
--config-kubernetesversion stringRequired if imported is false
--description stringDescription of MKS cluster
--displayname stringDisplay name of MKS cluster
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringUpdate MKS cluster from a YAML file
--fleet stringFleet of MKS cluster
-h, --helpHelp for mks
--name stringName of MKS cluster
--replaceIf enabled, replaces an existing MKS cluster

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringUpdate MKS OIDC connect from a YAML file
--fleet stringFleet of MKS OIDC connect
-h, --helpHelp for mksoidcconnect
--jwt-claims stringJWT claims in JSON format e.g. ‘{"aud": " ", "iss": " ", "sub": " "}’
--kosmos-role-arn stringARN of the role used to manage the MKS cluster
--name stringName of MKS OIDC connect
--region stringRegion of cluster

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--address stringAddress of vault configuration
--auth-secret-key stringAuth secret key of vault configuration
--auth-secret-name stringAuth secret name of vault configuration
--auth-token stringAuth token of vault configuration
--devspace stringDevSpace of vault configuration
--dry-runOutputs the yaml that would be sent as the request payload
--enabledWhether vault configuration is enabled
-f, --file stringUpdate vault configuration from a YAML file
--fleet stringFleet of vault configuration
-h, --helpHelp for vaultconfiguration
--name stringName of vault configuration
--sync-interval stringSync interval of vault configuration

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--description stringThe description to show in the UI for this virtual cluster
--devspace stringThe DevSpace to use
--display-name stringThe display name to show in the UI for this virtual cluster
-f, --file stringCreate virtual cluster from a YAML file
-h, --helpHelp for vcluster
-n, --name stringName of virtual cluster
--team stringThe team to create the space for
--user stringThe user to create the space for

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--access stringAccess rights for users and teams in JSON format e.g. ‘[{"name": " ", "verbs": [" "," "], "subresources": [" "," "], "users": [" "," "], "teams": [" "," "]}]’
--description stringDescription of virtual cluster template (default "desc")
--displayname stringDisplay name of virtual cluster template
--dry-runOutputs the yaml that would be sent as the request payload
-f, --file stringUpdate virtual cluster template from a YAML file
-h, --helpHelp for vclustertemplate
-n, --name stringName of virtual cluster template
--owner-team stringOwner team
--owner-user stringOwner user

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for use

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--disable-direct-cluster-endpointWhen enabled does not use an available direct cluster endpoint to connect to the cluster
--fleet stringFleet to use the cluster from
-h, --helpHelp for cluster
--printWhen enabled prints the context to stdout

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--disable-direct-cluster-endpointWhen enabled does not use an available direct cluster endpoint to connect to the cluster
-h, --helpHelp for hostcluster
--printWhen enabled prints the context to stdout

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for management
--printWhen enabled prints the context to stdout

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
--address stringThe local address to start port forwarding under
--background-proxyTry to use a background-proxy to access the vCluster. Only works if docker is installed and reachable. (Default true)
--cluster stringThe cluster to use
--cluster-role stringIf 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 stringThe DevSpace to use (default "b")
--disable-direct-cluster-endpointWhen enabled does not use an available direct cluster endpoint to connect to the vcluster
-h, --helpHelp for vcluster
--insecureIf specified, vCluster will create the kube config with insecure-skip-tls-verify
--kube-config stringWrites the created kube config to this file (default "./kubeconfig.yaml")
--kube-config-context-name stringIf set, will override the context name of the generated virtual cluster kube config with this name
--local-port intThe local port to forward the virtual cluster to. If empty, vCluster will use a random unused port
--name stringName of virtual cluster to use (default "n")
--pod stringThe pod to connect to
--printWhen enabled prints the context to stdout
--server stringThe server to connect to
--service-account stringIf 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-waitIf true, will not wait until the virtual cluster is running
--token-expiration intIf specified, vCluster will create the service account token for the given duration in seconds. Defaults to eternal
--update-currentIf true updates the current kube config. (Default true)

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for vars

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for cluster

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for username

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-h, --helpHelp for wakeup

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun 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

FlagDescription
-d, --devspace stringDevspace to get virtual cluster from
-h, --helpHelp for vcluster
-n, --name stringName of virtual cluster to wake up

Options inherited from parent commands

FlagDescription
--config stringThe kosmos config to use (will be created if it does not exist) (default "~/.kosmos/config.json")
--debugPrints the stack trace if an error occurs
-o, --log-output stringThe log format to use. Can be either plain, json, csv, markdown, or yaml (default "plain")
--silentRun in silent mode and prevents any kosmos log output except panics & fatals

Edit this page on GitHub