NeonCLI Reference

neon is a command-line tool used to configure and manage the nodes of a NeonKUBE cluster. It is included with NeonDESKTOP.

Run neon to see the list of available commands.

> neon

neon [v1.24.0]
Copyright c 2005-2023 by NeonFORGE LLC.  All rights reserved.

USAGE:

    neon [OPTIONS] COMMAND [ARG...]

NEON KUBECTL COMMANDS:

    [neon-cli] supports all standard kubectl commands like (more help below):

    neon apply -f my-manifest.yaml

NEON CLUSTER LIFE-CYCLE COMMANDS:

    neon cluster check
    neon cluster dashboard
    neon cluster health
    neon cluster info
    neon cluster islocked
    neon cluster lock
    neon cluster prepare    CLUSTER-DEF
    neon cluster pause      [OPTIONS]
    neon cluster delete     [OPTIONS]
    neon cluster reset      [OPTIONS]
    neon cluster setup      [OPTIONS] sysadmin@CLUSTER-NAME
    neon cluster start
    neon cluster stop       [OPTIONS]
    neon cluster unlock
    neon cluster verify     [CLUSTER-DEF]

    neon login              COMMAND
    neon logout

NEON HELM COMMANDS:

    The neon-cli supports all standard Helm commands by prefixing
    them with [helm], like:

    neon helm install -f my-values.yaml my-redis ./redis

NEON UTILITY COMMANDS:

    neon tool generate iso  SOURCE-FOLDER ISO-PATH
    neon tool password      COMMAND
    neon tool vault         COMMAND
    neon tool version       [-n] [--git] [--minimum=VERSION]

CLUSTER MANAGEMENT ARGUMENTS:

    CLUSTER-DEF         - Path to a cluster definition file.  This is
                          optional for some commands when logged in

    COMMAND             - Subcommand and arguments

NOTE: Command line arguments and options may include references to
      profile values, secrets and environment variables, like:

      ${profile:NAME}                   - profile value
      ${secret:NAME}                    - "password" property value of NAME secret
      ${secret:NAME:SOURCE}             - "password"  property value of NAME secret at SOURCE
      ${secret:NAME[PROPERTY}           - PROPERTY value from NAME secret
      ${secret:NAME[PROPERTY]:SOURCE}   - PROPERTY value from NAME secret at SOURCE
      ${env:NAME}                       - environment variable

      For Linux, you'll need to surround these references with single quotes
      to prevent Bash from interpreting them as Bash variable references.

===============================================================================

kubectl controls the Kubernetes cluster manager.

 Find more information at: https://kubernetes.io/docs/reference/kubectl/overview/

Basic Commands (Beginner):
  create          Create a resource from a file or from stdin
  expose          Take a replication controller, service, deployment or pod and expose it as a new Kubernetes service
  run             Run a particular image on the cluster
  set             Set specific features on objects

Basic Commands (Intermediate):
  explain         Get documentation for a resource
  get             Display one or many resources
  edit            Edit a resource on the server
  delete          Delete resources by file names, stdin, resources and names, or by resources and label selector

Deploy Commands:
  rollout         Manage the rollout of a resource
  scale           Set a new size for a deployment, replica set, or replication controller
  autoscale       Auto-scale a deployment, replica set, stateful set, or replication controller

Cluster Management Commands:
  certificate     Modify certificate resources.
  cluster-info    Display cluster information
  top             Display resource (CPU/memory) usage
  cordon          Mark node as unschedulable
  uncordon        Mark node as schedulable
  drain           Drain node in preparation for maintenance
  taint           Update the taints on one or more nodes

Troubleshooting and Debugging Commands:
  describe        Show details of a specific resource or group of resources
  logs            Print the logs for a container in a pod
  attach          Attach to a running container
  exec            Execute a command in a container
  port-forward    Forward one or more local ports to a pod
  proxy           Run a proxy to the Kubernetes API server
  cp              Copy files and directories to and from containers
  auth            Inspect authorization
  debug           Create debugging sessions for troubleshooting workloads and nodes

Advanced Commands:
  diff            Diff the live version against a would-be applied version
  apply           Apply a configuration to a resource by file name or stdin
  patch           Update fields of a resource
  replace         Replace a resource by file name or stdin
  wait            Experimental: Wait for a specific condition on one or many resources
  kustomize       Build a kustomization target from a directory or URL.

Settings Commands:
  label           Update the labels on a resource
  annotate        Update the annotations on a resource
  completion      Output shell completion code for the specified shell (bash, zsh or fish)

Other Commands:
  alpha           Commands for features in alpha
  api-resources   Print the supported API resources on the server
  api-versions    Print the supported API versions on the server, in the form of "group/version"
  config          Modify kubeconfig files
  plugin          Provides utilities for interacting with plugins
  version         Print the client and server version information

Usage:
  kubectl [flags] [options]

Use "kubectl <command> --help" for more information about a given command.
Use "kubectl options" for a list of global command-line options (applies to all commands).