From c2dd038c3d6607906a9f18db36b76148b01583b3 Mon Sep 17 00:00:00 2001 From: LucasSaintarbor Date: Thu, 11 Jan 2024 10:40:38 -0800 Subject: [PATCH 1/3] Update CLI commands for v2.6 - v2.8 --- .../cli-with-rancher/rancher-cli.md | 13 ++++++++++--- .../cli-with-rancher/rancher-cli.md | 13 ++++++++++--- .../cli-with-rancher/rancher-cli.md | 13 ++++++++++--- .../cli-with-rancher/rancher-cli.md | 13 ++++++++++--- 4 files changed, 40 insertions(+), 12 deletions(-) diff --git a/docs/reference-guides/cli-with-rancher/rancher-cli.md b/docs/reference-guides/cli-with-rancher/rancher-cli.md index 0c9a27c1694..09f2f33f70a 100644 --- a/docs/reference-guides/cli-with-rancher/rancher-cli.md +++ b/docs/reference-guides/cli-with-rancher/rancher-cli.md @@ -68,15 +68,22 @@ The following commands are available for use in Rancher CLI. | `catalog` | Performs operations on [catalogs](../../pages-for-subheaders/helm-charts-in-rancher.md). | | `clusters, [cluster]` | Performs operations on your [clusters](../../pages-for-subheaders/kubernetes-clusters-in-rancher-setup.md). | | `context` | Switches between Rancher [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md). For an example, see [Project Selection](#project-selection). | +| `globaldns` | Performs operations on global DNS providers and entries. | | `inspect [OPTIONS] [RESOURCEID RESOURCENAME]` | Displays details about [Kubernetes resources](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#resource-types) or Rancher resources (i.e.: [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md) and [workloads](../../pages-for-subheaders/workloads-and-pods.md)). Specify resources by name or ID. | -| `kubectl` |Runs [kubectl commands](https://kubernetes.io/docs/reference/kubectl/overview/#operations). | +| `kubectl` | Runs [kubectl commands](https://kubernetes.io/docs/reference/kubectl/overview/#operations). | | `login, [l]` | Logs into a Rancher Server. For an example, see [CLI Authentication](#cli-authentication). | -| `namespaces, [namespace]` |Performs operations on namespaces. | -| `nodes, [node]` |Performs operations on nodes. | +| machines, [machine] | Performs operations on machines. | +| multiclusterapps, [multiclusterapp mcapps mcapp] | Performs operations with multi-cluster apps. | +| `namespaces, [namespace]` | Performs operations on namespaces. | +| `nodes, [node]` | Performs operations on nodes. | | `projects, [project]` | Performs operations on [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md). | | `ps` | Displays [workloads](../../pages-for-subheaders/workloads-and-pods.md) in a project. | +| `server` | Performs operations for the server. | | `settings, [setting]` | Shows the current settings for your Rancher Server. | | `ssh` | Connects to one of your cluster nodes using the SSH protocol. | +| up | Applies compose config. | +| wait | Waits for resoruces clusters, app, project, multiClusterApp. | +| token | Authentictes and generates new kubeconfig token. | | `help, [h]` | Shows a list of commands or help for one command. | diff --git a/versioned_docs/version-2.6/reference-guides/cli-with-rancher/rancher-cli.md b/versioned_docs/version-2.6/reference-guides/cli-with-rancher/rancher-cli.md index 445d2b6446b..a4336208795 100644 --- a/versioned_docs/version-2.6/reference-guides/cli-with-rancher/rancher-cli.md +++ b/versioned_docs/version-2.6/reference-guides/cli-with-rancher/rancher-cli.md @@ -68,15 +68,22 @@ The following commands are available for use in Rancher CLI. | `catalog` | Performs operations on [catalogs](../../pages-for-subheaders/helm-charts-in-rancher.md). | | `clusters, [cluster]` | Performs operations on your [clusters](../../pages-for-subheaders/kubernetes-clusters-in-rancher-setup.md). | | `context` | Switches between Rancher [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md). For an example, see [Project Selection](#project-selection). | +| `globaldns` | Performs operations on global DNS providers and entries. | | `inspect [OPTIONS] [RESOURCEID RESOURCENAME]` | Displays details about [Kubernetes resources](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#resource-types) or Rancher resources (i.e.: [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md) and [workloads](../../pages-for-subheaders/workloads-and-pods.md)). Specify resources by name or ID. | -| `kubectl` |Runs [kubectl commands](https://kubernetes.io/docs/reference/kubectl/overview/#operations). | +| `kubectl` | Runs [kubectl commands](https://kubernetes.io/docs/reference/kubectl/overview/#operations). | | `login, [l]` | Logs into a Rancher Server. For an example, see [CLI Authentication](#cli-authentication). | -| `namespaces, [namespace]` |Performs operations on namespaces. | -| `nodes, [node]` |Performs operations on nodes. | +| `machines, [machine]` | Operations on machines | +| `multiclusterapps, [multiclusterapp mcapps mcapp]` | Performs operations with multi-cluster apps. | +| `namespaces, [namespace]` | Performs operations on namespaces. | +| `nodes, [node]` | Performs operations on nodes. | | `projects, [project]` | Performs operations on [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md). | | `ps` | Displays [workloads](../../pages-for-subheaders/workloads-and-pods.md) in a project. | +| `server` | Performs operations for the server. | | `settings, [setting]` | Shows the current settings for your Rancher Server. | | `ssh` | Connects to one of your cluster nodes using the SSH protocol. | +| up | Applies compose config. | +| wait | Waits for resoruces clusters, app, project, multiClusterApp. | +| token | Authentictes and generates new kubeconfig token. | | `help, [h]` | Shows a list of commands or help for one command. | diff --git a/versioned_docs/version-2.7/reference-guides/cli-with-rancher/rancher-cli.md b/versioned_docs/version-2.7/reference-guides/cli-with-rancher/rancher-cli.md index 0c9a27c1694..09f2f33f70a 100644 --- a/versioned_docs/version-2.7/reference-guides/cli-with-rancher/rancher-cli.md +++ b/versioned_docs/version-2.7/reference-guides/cli-with-rancher/rancher-cli.md @@ -68,15 +68,22 @@ The following commands are available for use in Rancher CLI. | `catalog` | Performs operations on [catalogs](../../pages-for-subheaders/helm-charts-in-rancher.md). | | `clusters, [cluster]` | Performs operations on your [clusters](../../pages-for-subheaders/kubernetes-clusters-in-rancher-setup.md). | | `context` | Switches between Rancher [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md). For an example, see [Project Selection](#project-selection). | +| `globaldns` | Performs operations on global DNS providers and entries. | | `inspect [OPTIONS] [RESOURCEID RESOURCENAME]` | Displays details about [Kubernetes resources](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#resource-types) or Rancher resources (i.e.: [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md) and [workloads](../../pages-for-subheaders/workloads-and-pods.md)). Specify resources by name or ID. | -| `kubectl` |Runs [kubectl commands](https://kubernetes.io/docs/reference/kubectl/overview/#operations). | +| `kubectl` | Runs [kubectl commands](https://kubernetes.io/docs/reference/kubectl/overview/#operations). | | `login, [l]` | Logs into a Rancher Server. For an example, see [CLI Authentication](#cli-authentication). | -| `namespaces, [namespace]` |Performs operations on namespaces. | -| `nodes, [node]` |Performs operations on nodes. | +| machines, [machine] | Performs operations on machines. | +| multiclusterapps, [multiclusterapp mcapps mcapp] | Performs operations with multi-cluster apps. | +| `namespaces, [namespace]` | Performs operations on namespaces. | +| `nodes, [node]` | Performs operations on nodes. | | `projects, [project]` | Performs operations on [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md). | | `ps` | Displays [workloads](../../pages-for-subheaders/workloads-and-pods.md) in a project. | +| `server` | Performs operations for the server. | | `settings, [setting]` | Shows the current settings for your Rancher Server. | | `ssh` | Connects to one of your cluster nodes using the SSH protocol. | +| up | Applies compose config. | +| wait | Waits for resoruces clusters, app, project, multiClusterApp. | +| token | Authentictes and generates new kubeconfig token. | | `help, [h]` | Shows a list of commands or help for one command. | diff --git a/versioned_docs/version-2.8/reference-guides/cli-with-rancher/rancher-cli.md b/versioned_docs/version-2.8/reference-guides/cli-with-rancher/rancher-cli.md index 0c9a27c1694..09f2f33f70a 100644 --- a/versioned_docs/version-2.8/reference-guides/cli-with-rancher/rancher-cli.md +++ b/versioned_docs/version-2.8/reference-guides/cli-with-rancher/rancher-cli.md @@ -68,15 +68,22 @@ The following commands are available for use in Rancher CLI. | `catalog` | Performs operations on [catalogs](../../pages-for-subheaders/helm-charts-in-rancher.md). | | `clusters, [cluster]` | Performs operations on your [clusters](../../pages-for-subheaders/kubernetes-clusters-in-rancher-setup.md). | | `context` | Switches between Rancher [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md). For an example, see [Project Selection](#project-selection). | +| `globaldns` | Performs operations on global DNS providers and entries. | | `inspect [OPTIONS] [RESOURCEID RESOURCENAME]` | Displays details about [Kubernetes resources](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#resource-types) or Rancher resources (i.e.: [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md) and [workloads](../../pages-for-subheaders/workloads-and-pods.md)). Specify resources by name or ID. | -| `kubectl` |Runs [kubectl commands](https://kubernetes.io/docs/reference/kubectl/overview/#operations). | +| `kubectl` | Runs [kubectl commands](https://kubernetes.io/docs/reference/kubectl/overview/#operations). | | `login, [l]` | Logs into a Rancher Server. For an example, see [CLI Authentication](#cli-authentication). | -| `namespaces, [namespace]` |Performs operations on namespaces. | -| `nodes, [node]` |Performs operations on nodes. | +| machines, [machine] | Performs operations on machines. | +| multiclusterapps, [multiclusterapp mcapps mcapp] | Performs operations with multi-cluster apps. | +| `namespaces, [namespace]` | Performs operations on namespaces. | +| `nodes, [node]` | Performs operations on nodes. | | `projects, [project]` | Performs operations on [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md). | | `ps` | Displays [workloads](../../pages-for-subheaders/workloads-and-pods.md) in a project. | +| `server` | Performs operations for the server. | | `settings, [setting]` | Shows the current settings for your Rancher Server. | | `ssh` | Connects to one of your cluster nodes using the SSH protocol. | +| up | Applies compose config. | +| wait | Waits for resoruces clusters, app, project, multiClusterApp. | +| token | Authentictes and generates new kubeconfig token. | | `help, [h]` | Shows a list of commands or help for one command. | From 2ae06b1abccbba7e2a17981f8389860dd2d4ad56 Mon Sep 17 00:00:00 2001 From: LucasSaintarbor Date: Thu, 1 Feb 2024 12:27:02 -0800 Subject: [PATCH 2/3] Review / update CLI commands --- .../cli-with-rancher/rancher-cli.md | 19 +++++++++---------- .../cli-with-rancher/rancher-cli.md | 18 +++++++++--------- .../cli-with-rancher/rancher-cli.md | 16 ++++++++-------- .../cli-with-rancher/rancher-cli.md | 19 +++++++++---------- 4 files changed, 35 insertions(+), 37 deletions(-) diff --git a/docs/reference-guides/cli-with-rancher/rancher-cli.md b/docs/reference-guides/cli-with-rancher/rancher-cli.md index 09f2f33f70a..1e5357c67de 100644 --- a/docs/reference-guides/cli-with-rancher/rancher-cli.md +++ b/docs/reference-guides/cli-with-rancher/rancher-cli.md @@ -68,25 +68,24 @@ The following commands are available for use in Rancher CLI. | `catalog` | Performs operations on [catalogs](../../pages-for-subheaders/helm-charts-in-rancher.md). | | `clusters, [cluster]` | Performs operations on your [clusters](../../pages-for-subheaders/kubernetes-clusters-in-rancher-setup.md). | | `context` | Switches between Rancher [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md). For an example, see [Project Selection](#project-selection). | -| `globaldns` | Performs operations on global DNS providers and entries. | +| `globaldns` | Performs operations on global DNS providers and entries. | | `inspect [OPTIONS] [RESOURCEID RESOURCENAME]` | Displays details about [Kubernetes resources](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#resource-types) or Rancher resources (i.e.: [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md) and [workloads](../../pages-for-subheaders/workloads-and-pods.md)). Specify resources by name or ID. | | `kubectl` | Runs [kubectl commands](https://kubernetes.io/docs/reference/kubectl/overview/#operations). | | `login, [l]` | Logs into a Rancher Server. For an example, see [CLI Authentication](#cli-authentication). | -| machines, [machine] | Performs operations on machines. | -| multiclusterapps, [multiclusterapp mcapps mcapp] | Performs operations with multi-cluster apps. | -| `namespaces, [namespace]` | Performs operations on namespaces. | -| `nodes, [node]` | Performs operations on nodes. | +| `machines, [machine]` | Performs operations on machines. | +| `multiclusterapps, [multiclusterapp mcapps mcapp]` | Performs operations with multi-cluster apps. | +| `namespaces, [namespace]` | Performs operations on [namespaces](../../how-to-guides/new-user-guides/manage-namespaces.md). | +| `nodes, [node]` | Performs operations on [nodes](../../how-to-guides/new-user-guides/manage-clusters/nodes-and-node-pools.md). | | `projects, [project]` | Performs operations on [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md). | | `ps` | Displays [workloads](../../pages-for-subheaders/workloads-and-pods.md) in a project. | -| `server` | Performs operations for the server. | +| `server` | Performs operations for the server. | | `settings, [setting]` | Shows the current settings for your Rancher Server. | | `ssh` | Connects to one of your cluster nodes using the SSH protocol. | -| up | Applies compose config. | -| wait | Waits for resoruces clusters, app, project, multiClusterApp. | -| token | Authentictes and generates new kubeconfig token. | +| `up` | Applies compose config. | +| `wait` | Waits for resoruces cluster, app, project, multiClusterApp. | +| `token` | Authentictes and generates new kubeconfig token. | | `help, [h]` | Shows a list of commands or help for one command. | - ### Rancher CLI Help Once logged into Rancher Server using the CLI, enter `./rancher --help` for a list of commands. diff --git a/versioned_docs/version-2.6/reference-guides/cli-with-rancher/rancher-cli.md b/versioned_docs/version-2.6/reference-guides/cli-with-rancher/rancher-cli.md index a4336208795..99e62147663 100644 --- a/versioned_docs/version-2.6/reference-guides/cli-with-rancher/rancher-cli.md +++ b/versioned_docs/version-2.6/reference-guides/cli-with-rancher/rancher-cli.md @@ -68,22 +68,22 @@ The following commands are available for use in Rancher CLI. | `catalog` | Performs operations on [catalogs](../../pages-for-subheaders/helm-charts-in-rancher.md). | | `clusters, [cluster]` | Performs operations on your [clusters](../../pages-for-subheaders/kubernetes-clusters-in-rancher-setup.md). | | `context` | Switches between Rancher [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md). For an example, see [Project Selection](#project-selection). | -| `globaldns` | Performs operations on global DNS providers and entries. | +| `globaldns` | Performs operations on global DNS providers and entries. | | `inspect [OPTIONS] [RESOURCEID RESOURCENAME]` | Displays details about [Kubernetes resources](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#resource-types) or Rancher resources (i.e.: [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md) and [workloads](../../pages-for-subheaders/workloads-and-pods.md)). Specify resources by name or ID. | | `kubectl` | Runs [kubectl commands](https://kubernetes.io/docs/reference/kubectl/overview/#operations). | | `login, [l]` | Logs into a Rancher Server. For an example, see [CLI Authentication](#cli-authentication). | -| `machines, [machine]` | Operations on machines | -| `multiclusterapps, [multiclusterapp mcapps mcapp]` | Performs operations with multi-cluster apps. | -| `namespaces, [namespace]` | Performs operations on namespaces. | -| `nodes, [node]` | Performs operations on nodes. | +| `machines, [machine]` | Performs operations on machines. | +| `multiclusterapps, [multiclusterapp mcapps mcapp]` | Performs operations with multi-cluster apps. | +| `namespaces, [namespace]` | Performs operations on [namespaces](../../how-to-guides/new-user-guides/manage-namespaces.md). | +| `nodes, [node]` | Performs operations on [nodes](../../how-to-guides/new-user-guides/manage-clusters/nodes-and-node-pools.md). | | `projects, [project]` | Performs operations on [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md). | | `ps` | Displays [workloads](../../pages-for-subheaders/workloads-and-pods.md) in a project. | -| `server` | Performs operations for the server. | +| `server` | Performs operations for the server. | | `settings, [setting]` | Shows the current settings for your Rancher Server. | | `ssh` | Connects to one of your cluster nodes using the SSH protocol. | -| up | Applies compose config. | -| wait | Waits for resoruces clusters, app, project, multiClusterApp. | -| token | Authentictes and generates new kubeconfig token. | +| `up` | Applies compose config. | +| `wait` | Waits for resoruces cluster, app, project, multiClusterApp. | +| `token` | Authentictes and generates new kubeconfig token. | | `help, [h]` | Shows a list of commands or help for one command. | diff --git a/versioned_docs/version-2.7/reference-guides/cli-with-rancher/rancher-cli.md b/versioned_docs/version-2.7/reference-guides/cli-with-rancher/rancher-cli.md index 09f2f33f70a..43989a19581 100644 --- a/versioned_docs/version-2.7/reference-guides/cli-with-rancher/rancher-cli.md +++ b/versioned_docs/version-2.7/reference-guides/cli-with-rancher/rancher-cli.md @@ -72,18 +72,18 @@ The following commands are available for use in Rancher CLI. | `inspect [OPTIONS] [RESOURCEID RESOURCENAME]` | Displays details about [Kubernetes resources](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#resource-types) or Rancher resources (i.e.: [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md) and [workloads](../../pages-for-subheaders/workloads-and-pods.md)). Specify resources by name or ID. | | `kubectl` | Runs [kubectl commands](https://kubernetes.io/docs/reference/kubectl/overview/#operations). | | `login, [l]` | Logs into a Rancher Server. For an example, see [CLI Authentication](#cli-authentication). | -| machines, [machine] | Performs operations on machines. | -| multiclusterapps, [multiclusterapp mcapps mcapp] | Performs operations with multi-cluster apps. | -| `namespaces, [namespace]` | Performs operations on namespaces. | -| `nodes, [node]` | Performs operations on nodes. | +| machines, [machine] | Performs operations on machines. | +| `multiclusterapps, [multiclusterapp mcapps mcapp]` | Performs operations with multi-cluster apps. | +| `namespaces, [namespace]` | Performs operations on [namespaces](../../how-to-guides/new-user-guides/manage-namespaces.md). | +| `nodes, [node]` | Performs operations on [nodes](../../how-to-guides/new-user-guides/manage-clusters/nodes-and-node-pools.md). | | `projects, [project]` | Performs operations on [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md). | | `ps` | Displays [workloads](../../pages-for-subheaders/workloads-and-pods.md) in a project. | -| `server` | Performs operations for the server. | +| `server` | Performs operations for the server. | | `settings, [setting]` | Shows the current settings for your Rancher Server. | | `ssh` | Connects to one of your cluster nodes using the SSH protocol. | -| up | Applies compose config. | -| wait | Waits for resoruces clusters, app, project, multiClusterApp. | -| token | Authentictes and generates new kubeconfig token. | +| `up` | Applies compose config. | +| `wait` | Waits for resoruces cluster, app, project, multiClusterApp. | +| `token` | Authentictes and generates new kubeconfig token. | | `help, [h]` | Shows a list of commands or help for one command. | diff --git a/versioned_docs/version-2.8/reference-guides/cli-with-rancher/rancher-cli.md b/versioned_docs/version-2.8/reference-guides/cli-with-rancher/rancher-cli.md index 09f2f33f70a..1e5357c67de 100644 --- a/versioned_docs/version-2.8/reference-guides/cli-with-rancher/rancher-cli.md +++ b/versioned_docs/version-2.8/reference-guides/cli-with-rancher/rancher-cli.md @@ -68,25 +68,24 @@ The following commands are available for use in Rancher CLI. | `catalog` | Performs operations on [catalogs](../../pages-for-subheaders/helm-charts-in-rancher.md). | | `clusters, [cluster]` | Performs operations on your [clusters](../../pages-for-subheaders/kubernetes-clusters-in-rancher-setup.md). | | `context` | Switches between Rancher [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md). For an example, see [Project Selection](#project-selection). | -| `globaldns` | Performs operations on global DNS providers and entries. | +| `globaldns` | Performs operations on global DNS providers and entries. | | `inspect [OPTIONS] [RESOURCEID RESOURCENAME]` | Displays details about [Kubernetes resources](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#resource-types) or Rancher resources (i.e.: [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md) and [workloads](../../pages-for-subheaders/workloads-and-pods.md)). Specify resources by name or ID. | | `kubectl` | Runs [kubectl commands](https://kubernetes.io/docs/reference/kubectl/overview/#operations). | | `login, [l]` | Logs into a Rancher Server. For an example, see [CLI Authentication](#cli-authentication). | -| machines, [machine] | Performs operations on machines. | -| multiclusterapps, [multiclusterapp mcapps mcapp] | Performs operations with multi-cluster apps. | -| `namespaces, [namespace]` | Performs operations on namespaces. | -| `nodes, [node]` | Performs operations on nodes. | +| `machines, [machine]` | Performs operations on machines. | +| `multiclusterapps, [multiclusterapp mcapps mcapp]` | Performs operations with multi-cluster apps. | +| `namespaces, [namespace]` | Performs operations on [namespaces](../../how-to-guides/new-user-guides/manage-namespaces.md). | +| `nodes, [node]` | Performs operations on [nodes](../../how-to-guides/new-user-guides/manage-clusters/nodes-and-node-pools.md). | | `projects, [project]` | Performs operations on [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md). | | `ps` | Displays [workloads](../../pages-for-subheaders/workloads-and-pods.md) in a project. | -| `server` | Performs operations for the server. | +| `server` | Performs operations for the server. | | `settings, [setting]` | Shows the current settings for your Rancher Server. | | `ssh` | Connects to one of your cluster nodes using the SSH protocol. | -| up | Applies compose config. | -| wait | Waits for resoruces clusters, app, project, multiClusterApp. | -| token | Authentictes and generates new kubeconfig token. | +| `up` | Applies compose config. | +| `wait` | Waits for resoruces cluster, app, project, multiClusterApp. | +| `token` | Authentictes and generates new kubeconfig token. | | `help, [h]` | Shows a list of commands or help for one command. | - ### Rancher CLI Help Once logged into Rancher Server using the CLI, enter `./rancher --help` for a list of commands. From 8fcf90f7ac648fea14636686cbefeabdc32efa25 Mon Sep 17 00:00:00 2001 From: Lucas Saintarbor Date: Mon, 12 Feb 2024 10:57:10 -0800 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Marty Hernandez Avedon Co-authored-by: Billy Tat --- docs/reference-guides/cli-with-rancher/rancher-cli.md | 4 ++-- .../reference-guides/cli-with-rancher/rancher-cli.md | 4 ++-- .../reference-guides/cli-with-rancher/rancher-cli.md | 8 ++++---- .../reference-guides/cli-with-rancher/rancher-cli.md | 4 ++-- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/reference-guides/cli-with-rancher/rancher-cli.md b/docs/reference-guides/cli-with-rancher/rancher-cli.md index 1e5357c67de..2cc1bd1ed7c 100644 --- a/docs/reference-guides/cli-with-rancher/rancher-cli.md +++ b/docs/reference-guides/cli-with-rancher/rancher-cli.md @@ -82,8 +82,8 @@ The following commands are available for use in Rancher CLI. | `settings, [setting]` | Shows the current settings for your Rancher Server. | | `ssh` | Connects to one of your cluster nodes using the SSH protocol. | | `up` | Applies compose config. | -| `wait` | Waits for resoruces cluster, app, project, multiClusterApp. | -| `token` | Authentictes and generates new kubeconfig token. | +| `wait` | Waits for resources cluster, app, project, multiClusterApp. | +| `token` | Authenticates and generates new kubeconfig token. | | `help, [h]` | Shows a list of commands or help for one command. | ### Rancher CLI Help diff --git a/versioned_docs/version-2.6/reference-guides/cli-with-rancher/rancher-cli.md b/versioned_docs/version-2.6/reference-guides/cli-with-rancher/rancher-cli.md index 99e62147663..f165979807d 100644 --- a/versioned_docs/version-2.6/reference-guides/cli-with-rancher/rancher-cli.md +++ b/versioned_docs/version-2.6/reference-guides/cli-with-rancher/rancher-cli.md @@ -82,8 +82,8 @@ The following commands are available for use in Rancher CLI. | `settings, [setting]` | Shows the current settings for your Rancher Server. | | `ssh` | Connects to one of your cluster nodes using the SSH protocol. | | `up` | Applies compose config. | -| `wait` | Waits for resoruces cluster, app, project, multiClusterApp. | -| `token` | Authentictes and generates new kubeconfig token. | +| `wait` | Waits for resources cluster, app, project, multiClusterApp. | +| `token` | Authenticates and generates new kubeconfig token. | | `help, [h]` | Shows a list of commands or help for one command. | diff --git a/versioned_docs/version-2.7/reference-guides/cli-with-rancher/rancher-cli.md b/versioned_docs/version-2.7/reference-guides/cli-with-rancher/rancher-cli.md index 43989a19581..2970348c8f9 100644 --- a/versioned_docs/version-2.7/reference-guides/cli-with-rancher/rancher-cli.md +++ b/versioned_docs/version-2.7/reference-guides/cli-with-rancher/rancher-cli.md @@ -68,11 +68,11 @@ The following commands are available for use in Rancher CLI. | `catalog` | Performs operations on [catalogs](../../pages-for-subheaders/helm-charts-in-rancher.md). | | `clusters, [cluster]` | Performs operations on your [clusters](../../pages-for-subheaders/kubernetes-clusters-in-rancher-setup.md). | | `context` | Switches between Rancher [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md). For an example, see [Project Selection](#project-selection). | -| `globaldns` | Performs operations on global DNS providers and entries. | +| `globaldns` | Performs operations on global DNS providers and entries. | | `inspect [OPTIONS] [RESOURCEID RESOURCENAME]` | Displays details about [Kubernetes resources](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#resource-types) or Rancher resources (i.e.: [projects](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md) and [workloads](../../pages-for-subheaders/workloads-and-pods.md)). Specify resources by name or ID. | | `kubectl` | Runs [kubectl commands](https://kubernetes.io/docs/reference/kubectl/overview/#operations). | | `login, [l]` | Logs into a Rancher Server. For an example, see [CLI Authentication](#cli-authentication). | -| machines, [machine] | Performs operations on machines. | +| `machines, [machine]` | Performs operations on machines. | | `multiclusterapps, [multiclusterapp mcapps mcapp]` | Performs operations with multi-cluster apps. | | `namespaces, [namespace]` | Performs operations on [namespaces](../../how-to-guides/new-user-guides/manage-namespaces.md). | | `nodes, [node]` | Performs operations on [nodes](../../how-to-guides/new-user-guides/manage-clusters/nodes-and-node-pools.md). | @@ -82,8 +82,8 @@ The following commands are available for use in Rancher CLI. | `settings, [setting]` | Shows the current settings for your Rancher Server. | | `ssh` | Connects to one of your cluster nodes using the SSH protocol. | | `up` | Applies compose config. | -| `wait` | Waits for resoruces cluster, app, project, multiClusterApp. | -| `token` | Authentictes and generates new kubeconfig token. | +| `wait` | Waits for resources cluster, app, project, multiClusterApp. | +| `token` | Authenticates and generates new kubeconfig token. | | `help, [h]` | Shows a list of commands or help for one command. | diff --git a/versioned_docs/version-2.8/reference-guides/cli-with-rancher/rancher-cli.md b/versioned_docs/version-2.8/reference-guides/cli-with-rancher/rancher-cli.md index 1e5357c67de..2cc1bd1ed7c 100644 --- a/versioned_docs/version-2.8/reference-guides/cli-with-rancher/rancher-cli.md +++ b/versioned_docs/version-2.8/reference-guides/cli-with-rancher/rancher-cli.md @@ -82,8 +82,8 @@ The following commands are available for use in Rancher CLI. | `settings, [setting]` | Shows the current settings for your Rancher Server. | | `ssh` | Connects to one of your cluster nodes using the SSH protocol. | | `up` | Applies compose config. | -| `wait` | Waits for resoruces cluster, app, project, multiClusterApp. | -| `token` | Authentictes and generates new kubeconfig token. | +| `wait` | Waits for resources cluster, app, project, multiClusterApp. | +| `token` | Authenticates and generates new kubeconfig token. | | `help, [h]` | Shows a list of commands or help for one command. | ### Rancher CLI Help