Skip to main content

CLI

edge​

edge --help
NAME:
   edge - manage k3s clusters and containerized apps (as helmcharts) anywhere

USAGE:
   edge [global options] command [command options] [arguments...]

VERSION:
   v0.0.1-alpha1

COMMANDS:
   k3s, cluster, c  manage k3s clusters
   kubectl, k       run kubectl-like commands
   server, s        start the server for REST API and web UI
   help, h          Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --config value, -c value                                               config file path (default: $HOME/.edge/edge.yaml, if it exists) [$EDGE_CONFIG]
   --log-level value, -l value                                            logging level. options: debug, info, warn, error (default: "info") [$EDGE_LOG_LEVEL]
   --kubeconfig value, -k value                                           kubeconfig file. in-cluster configuration (ServiceAccount) is used if not provided [$KUBECONFIG]
   --extraHelmRepos value, -r value [ --extraHelmRepos value, -r value ]  extra repos, in the form 'name=repo_url', can be specified multiple times [$EDGE_EXTRAHELMREPOS]
   --help, -h                                                             show help
   --version, -v                                                          print the version

server​

edge server --help
NAME:
   edge server - start the server for REST API and web UI

USAGE:
   edge server [command options] [arguments...]

OPTIONS:
   --http-port value, -p value                                                            HTTP port to listen on (default: 8080) [$EDGE_HTTP_PORT]
   --http-enableLog, -l                                                                   whether to log HTTP requests (default: false) [$EDGE_HTTP_ENABLELOG]
   --http-cors-enabled, -c                                                                whether to allow CORS (default: false) [$EDGE_HTTP_CORS_ENABLED]
   --http-cors-allowOrigins value, -o value [ --http-cors-allowOrigins value, -o value ]  allowed origins for CORS (default: "*") [$EDGE_HTTP_CORS_ALLOWORIGINS]
   --http-auth-type value, -t value                                                       HTTP Auth type (default: "none") [$EDGE_HTTP_AUTH_TYPE]
   --http-auth-basic-username value, -u value                                             HTTP Basic Auth username (default: "edge") [$EDGE_HTTP_AUTH_BASIC_USERNAME]
   --http-auth-basic-password value, -w value                                             HTTP Basic Auth password (default: "edge") [$EDGE_HTTP_AUTH_BASIC_PASSWORD]
   --http-auth-jwt-issuer value, -i value                                                 HTTP JWT Auth issuer [$EDGE_HTTP_AUTH_JWT_ISSUER]
   --http-auth-jwt-clientId value, -a value                                               HTTP JWT Auth clientId [$EDGE_HTTP_AUTH_JWT_CLIENTID]
   --http-auth-jwt-jwkEndpoint value, -j value                                            HTTP JWT Auth JWK endpoint [$EDGE_HTTP_AUTH_JWT_JWKENDPOINT]
   --help, -h                                                                             show help

k3s​

edge k3s --help
NAME:
   edge k3s - manage k3s clusters

USAGE:
   edge k3s command [command options] [arguments...]

COMMANDS:
   install, i             Install k3s on a remote host
   join, j                Join a k3s cluster
   uninstall, destroy, d  Uninstall k3s on a remote host
   update, u              Update k3s on a remote host
   copy-kubeconfig, cpk   Copy kubeconfig from remote host
   ls, l                  List k3s clusters
   nodes, n               List nodes in a k3s cluster
   help, h                Shows a list of commands or help for one command

OPTIONS:
   --help, -h  show help

k3s install, join, ... options​

edge k3s install --help
NAME:
   edge k3s install - Install k3s on a remote host

USAGE:
   edge k3s install [command options] [arguments...]

OPTIONS:
   --host value, -H value                           host IP or domainname of target node
   --user value, -u value                           ssh username of target node
   --password value, -p value                       password for ssh authentication
   --keyfile value, -k value                        path to ssh private key file
   --port value, -P value                           SSH port (default: 22)
   --env value, -e value [ --env value, -e value ]  environment variables in the form KEY=VALUE
   --keypassphrase value, -K value                  passphrase for ssh private key
   --tls-san value, -s value                        Add additional hostnames or IPv4/IPv6 addresses as Subject Alternative Names on the server TLS cert
   --cluster, -c                                    Initialize a new cluster using embedded Etcd (default: false) [$EDGE_K3S_CLUSTER]
   --k3s-args value                                 Additional arguments to pass to k3s installer
   --version value, -v value                        Install a specific version. Leave empty for the latest stable version
   --no-copy-kubeconfig, --nck                      Skip copying kubeconfig from the remote host after installation (default: false)
   --help, -h                                       show help                                     show help

kubectl​

edge kubectl --help
NAME:
   edge kubectl - run kubectl-like commands

USAGE:
   edge kubectl command [command options] [arguments...]

COMMANDS:
   get, g            Get resources. Supply resource arg in PLURAL, eg, pods, namespaces, deployments
   apply, create, a  Create a resource, or patch/update if it already exists
   delete, d         Delete a resource
   help, h           Shows a list of commands or help for one command

OPTIONS:
   --namespace value, -n value  Namespace to use for the kubectl command
   --output value, -o value     Output format. One of: name|yaml|json (default: "name")
   --help, -h                   show help