mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-05-17 18:37:03 +00:00
Marty Hernandez Avedon
5274e4e000
* added ui instructions for cluster list to access-clusters * re-org access-clusters so that 'Cluster List' becomes a searchable heading * rewording * added instructions and links for Global Settings * added global config + retitle/rephrase retitle to disambiguate global settings from global config listed some relevant global config items that need more info * correction: updated access-clusters page in /docs, not /versioned_docs * added Nodes UI instructions * download kubeconfig UI instructions added/modified one file contained correct instructions but they were somewhat convoluted, as you can download the file from a page mentioned earlier in the suggested instructions and the button thery describe is an icon, not labeled with any text * restoring formatting * updated pathway for image list downloads * finding rancher-images.txt * added instructions for Apps Marketplace * link pointing to v1 monitoring * link pointing to v1 dashboards * added links for v1 notifiers, logging tools * global dns entries, global dns providers, catalog links added * Rancher portal > Rancher UI * updated access-clusters page * rm note & add third way to access cluster dashboard * heading levels * addressed comments in global-configuration * addressed comments for nodes-and-node-pools * addressed comment on authorized-cluster-endpoint * rm'd create apps steps * updated kubeconfig download instructions * adjusting headers * updated images list instructions as version # is now an About link * restored intro to monitoring-and-alerting * KubeConfig > kubeconfig (except for naming the UI label) * left navigation sidebar > left navigation * Update docs/how-to-guides/new-user-guides/manage-clusters/access-clusters/authorized-cluster-endpoint.md Co-authored-by: Billy Tat <btat@suse.com> * applied changes to v2.7 docs --------- Co-authored-by: Billy Tat <btat@suse.com>
65 lines
3.6 KiB
Markdown
65 lines
3.6 KiB
Markdown
---
|
|
title: Cluster Access
|
|
---
|
|
|
|
<head>
|
|
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/access-clusters"/>
|
|
</head>
|
|
|
|
This section is about what tools can be used to access clusters managed by Rancher.
|
|
|
|
For information on how to give users permission to access a cluster, see the section on [adding users to clusters.](../how-to-guides/new-user-guides/manage-clusters/access-clusters/add-users-to-clusters.md)
|
|
|
|
For more information on roles-based access control, see [this section.](manage-role-based-access-control-rbac.md)
|
|
|
|
For information on how to set up an authentication system, see [this section.](authentication-config.md)
|
|
|
|
On the **Clusters** page, select **⁝** at the end of each row to view a submenu with the following options:
|
|
|
|
* [Kubectl Shell](../how-to-guides/advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md)
|
|
* Download KubeConfig
|
|
* Copy KubeConfig to Clipboard
|
|
* Edit Config
|
|
* View YAML
|
|
* Download YAML
|
|
|
|
### Cluster Dashboard
|
|
|
|
On the **Clusters** page, select the **Explore** button at the end of each row to view that cluster's **Cluster Dashboard**. You can also view the dashboard by clicking the name of a cluster in the table, then clicking the **Explore** buttton on the **Cluster** page.
|
|
|
|
The **Cluster Dashboard** is also accessible from the Rancher UI **Home** page, by clicking on the name of a cluster.
|
|
|
|
You can also access the **Cluster Dashboard** from the **☰** in the top navigation bar:
|
|
|
|
1. Click **☰**.
|
|
1. Select the name of a cluster from the **Explore Cluster** menu option.
|
|
|
|
The **Cluster Dashboard** lists information about a specific cluster, such as number of nodes, memory usage, events, and resources.
|
|
|
|
## kubectl
|
|
|
|
## Clusters in Rancher UI
|
|
|
|
There are several paths to view and manage clusters through the Rancher UI.
|
|
|
|
### Clusters Page
|
|
|
|
You can access the **Clusters** page from the **☰** menu:
|
|
|
|
1. Click **☰**.
|
|
1. Select **Cluster Management**.
|
|
|
|
You can also access the **Clusters** page by clicking the **Manage** button above the clusters table on the Rancher UI **Home** page.
|
|
|
|
You can use the Kubernetes command-line tool, [kubectl](https://kubernetes.io/docs/reference/kubectl/overview/), to manage your clusters. You have two options for using kubectl:
|
|
|
|
- **Rancher kubectl shell:** Interact with your clusters by launching a kubectl shell available in the Rancher UI. This option requires no configuration actions on your part. For more information, see [Accessing Clusters with kubectl Shell](../how-to-guides/new-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md).
|
|
- **Terminal remote connection:** You can also interact with your clusters by installing [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) on your local desktop and then copying the cluster's kubeconfig file to your local `~/.kube/config` directory. For more information, see [Accessing Clusters with kubectl and a kubeconfig File](../how-to-guides/new-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md).
|
|
|
|
## Rancher CLI
|
|
|
|
You can control your clusters by downloading Rancher's own command-line interface, [Rancher CLI](cli-with-rancher.md). This CLI tool can interact directly with different clusters and projects or pass them `kubectl` commands.
|
|
|
|
## Rancher API
|
|
|
|
Finally, you can interact with your clusters over the Rancher API. Before you use the API, you must obtain an [API key](../reference-guides/user-settings/api-keys.md). To view the different resource fields and actions for an API object, open the API UI, which can be accessed by clicking on **View in API** for any Rancher UI object. |