scaleway-cli icon indicating copy to clipboard operation
scaleway-cli copied to clipboard

Reorder usage in help

Open remyleone opened this issue 5 years ago • 3 comments

  1. Example
  2. Options
  3. Description
  4. Usage
  5. Errors

(See kubectl...)

remyleone avatar Apr 24 '20 13:04 remyleone

Current is:

  1. Description
  2. Usage
  3. Examples
  4. Args (Options)
  5. Deprecated Args
  6. Flags
  7. Global Flags

On kubectl:

  1. Description
  2. Examples
  3. Options
  4. Usage

Codelax avatar Sep 14 '22 09:09 Codelax

Current

 ± scw k8s cluster create -h
This method allows to create a new Kubernetes cluster on an account.

USAGE:
  scw k8s cluster create [arg=value ...]

EXAMPLES:
  Create a Kubernetes cluster named foo with cilium as CNI, in version 1.17.4 and with a pool named default composed of 3 DEV1-M
    scw k8s cluster create name=foo version=1.17.4 pools.0.size=3 pools.0.node-type=DEV1-M pools.0.name=default

  Create a Kubernetes cluster named bar, tagged, calico as CNI, in version 1.17.4 and with a tagged pool named default composed of 2 RENDER-S and autohealing and autoscaling enabled (between 1 and 10 nodes)
    scw k8s cluster create name=bar version=1.17.4 tags.0=tag1 tags.1=tag2 cni=cilium pools.0.size=2 pools.0.node-type=RENDER-S pools.0.min-size=1 pools.0.max-size=10 pools.0.autohealing=true pools.0.autoscaling=true pools.0.tags.0=pooltag1 pools.0.tags.1=pooltag2 pools.0.name=default

ARGS:
  [project-id]                                           Project ID to use. If none is passed the default project ID will be used
  [type]                                                 The type of the cluster
  name=<generated>                                       The name of the cluster
  [description]                                          The description of the cluster
  [tags.{index}]                                         The tags associated with the cluster
  version=latest                                         The Kubernetes version of the cluster
  cni=cilium                                             The Container Network Interface (CNI) plugin that will run in the cluster (unknown_cni | cilium | calico | weave | flannel | kilo)
  pools.{index}.name                                     The name of the pool
  pools.{index}.node-type                                The node type is the type of Scaleway Instance wanted for the pool
  [pools.{index}.placement-group-id]                     The placement group ID in which all the nodes of the pool will be created
  [pools.{index}.autoscaling]                            The enablement of the autoscaling feature for the pool
  pools.{index}.size                                     The size (number of nodes) of the pool
  [pools.{index}.min-size]                               The minimum size of the pool
  [pools.{index}.max-size]                               The maximum size of the pool
  [pools.{index}.container-runtime]                      The container runtime for the nodes of the pool (unknown_runtime | docker | containerd | crio)
  [pools.{index}.autohealing]                            The enablement of the autohealing feature for the pool
  [pools.{index}.tags.{index}]                           The tags associated with the pool
  [pools.{index}.kubelet-args.{key}]                     
  [pools.{index}.upgrade-policy.max-unavailable]         The maximum number of nodes that can be not ready at the same time
  [pools.{index}.upgrade-policy.max-surge]               The maximum number of nodes to be created during the upgrade
  [pools.{index}.zone]                                   The Zone in which the Pool's node will be spawn in
  [pools.{index}.root-volume-type]                       The system volume disk type (default_volume_type | l_ssd | b_ssd)
  [pools.{index}.root-volume-size]                       The system volume disk size
  [autoscaler-config.scale-down-disabled]                Disable the cluster autoscaler
  [autoscaler-config.scale-down-delay-after-add]         How long after scale up that scale down evaluation resumes
  [autoscaler-config.estimator]                          Type of resource estimator to be used in scale up (unknown_estimator | binpacking)
  [autoscaler-config.expander]                           Type of node group expander to be used in scale up (unknown_expander | random | most_pods | least_waste | priority | price)
  [autoscaler-config.ignore-daemonsets-utilization]      Ignore DaemonSet pods when calculating resource utilization for scaling down
  [autoscaler-config.balance-similar-node-groups]        Detect similar node groups and balance the number of nodes between them
  [autoscaler-config.expendable-pods-priority-cutoff]    Pods with priority below cutoff will be expendable
  [autoscaler-config.scale-down-unneeded-time]           How long a node should be unneeded before it is eligible for scale down
  [autoscaler-config.scale-down-utilization-threshold]   Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down
  [autoscaler-config.max-graceful-termination-sec]       Maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node
  [auto-upgrade.enable]                                  Whether or not auto upgrade is enabled for the cluster
  [auto-upgrade.maintenance-window.start-hour]           The start hour of the 2-hour maintenance window
  [auto-upgrade.maintenance-window.day]                  The day of the week for the maintenance window (any | monday | tuesday | wednesday | thursday | friday | saturday | sunday)
  [feature-gates.{index}]                                List of feature gates to enable
  [admission-plugins.{index}]                            List of admission plugins to enable
  [open-id-connect-config.issuer-url]                    URL of the provider which allows the API server to discover public signing keys
  [open-id-connect-config.client-id]                     A client id that all tokens must be issued for
  [open-id-connect-config.username-claim]                JWT claim to use as the user name
  [open-id-connect-config.username-prefix]               Prefix prepended to username
  [open-id-connect-config.groups-claim.{index}]          JWT claim to use as the user's group
  [open-id-connect-config.groups-prefix]                 Prefix prepended to group claims
  [open-id-connect-config.required-claim.{index}]        Multiple key=value pairs that describes a required claim in the ID Token
  [apiserver-cert-sans.{index}]                          Additional Subject Alternative Names for the Kubernetes API server certificate
  [organization-id]                                      Organization ID to use. If none is passed the default organization ID will be used
  [region=fr-par]                                        Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

DEPRECATED ARGS:
  [enable-dashboard]   The enablement of the Kubernetes Dashboard in the cluster
  [ingress]            The Ingress Controller that will run in the cluster (unknown_ingress | none | nginx | traefik | traefik2)

FLAGS:
  -h, --help   help for create
  -w, --wait   wait until the cluster is ready

GLOBAL FLAGS:
  -c, --config string    The path to the config file
  -D, --debug            Enable debug mode
  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")

Codelax avatar Sep 14 '22 10:09 Codelax

kubectl

 ± kubectl create deployment -h      
Create a deployment with the specified name.

Aliases:
deployment, deploy

Examples:
  # Create a deployment named my-dep that runs the busybox image
  kubectl create deployment my-dep --image=busybox
  
  # Create a deployment with a command
  kubectl create deployment my-dep --image=busybox -- date
  
  # Create a deployment named my-dep that runs the nginx image with 3 replicas
  kubectl create deployment my-dep --image=nginx --replicas=3
  
  # Create a deployment named my-dep that runs the busybox image and expose port 5701
  kubectl create deployment my-dep --image=busybox --port=5701

Options:
      --allow-missing-template-keys=true: If true, ignore any errors in templates when a field or map key is missing in
the template. Only applies to golang and jsonpath output formats.
      --dry-run='none': Must be "none", "server", or "client". If client strategy, only print the object that would be
sent, without sending it. If server strategy, submit server-side request without persisting the resource.
      --field-manager='kubectl-create': Name of the manager used to track field ownership.
      --image=[]: Image names to run.
  -o, --output='': Output format. One of:
json|yaml|name|go-template|go-template-file|template|templatefile|jsonpath|jsonpath-as-json|jsonpath-file.
      --port=-1: The port that this container exposes.
  -r, --replicas=1: Number of replicas to create. Default is 1.
      --save-config=false: If true, the configuration of current object will be saved in its annotation. Otherwise, the
annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.
      --show-managed-fields=false: If true, keep the managedFields when printing objects in JSON or YAML format.
      --template='': Template string or path to template file to use when -o=go-template, -o=go-template-file. The
template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
      --validate=true: If true, use a schema to validate the input before sending it

Usage:
  kubectl create deployment NAME --image=image -- [COMMAND] [args...] [options]

Use "kubectl options" for a list of global command-line options (applies to all commands).

Codelax avatar Sep 14 '22 10:09 Codelax