Este documento foi traduzido usando tecnologia de tradução automática de máquina. Sempre trabalhamos para apresentar traduções precisas, mas não oferecemos nenhuma garantia em relação à integridade, precisão ou confiabilidade do conteúdo traduzido. Em caso de qualquer discrepância, a versão original em inglês prevalecerá e constituirá o texto official.

SUSE Rancher Prime CLI

O Rancher CLI (Interface de Linha de Comando) é uma ferramenta unificada que você pode usar para interagir com o Rancher. Com esta ferramenta, você pode operar o Rancher usando a linha de comando em vez da GUI.

Baixar Rancher CLI

O binário pode ser baixado diretamente da GUI.

No canto superior esquerdo, clique em ☰.
Na parte inferior do menu lateral de navegação, clique em Sobre.
Na seção Downloads do CLI, há links para baixar os binários para Windows, Mac e Linux. Você também pode verificar a Página de lançamentos do nosso CLI para downloads diretos do binário.

Requisitos

Após baixar o Rancher CLI, você precisa fazer algumas configurações. O Rancher CLI requer:

A URL do seu Servidor Rancher, que é usada para conectar ao Servidor Rancher.
Um token Bearer da API, que é usado para autenticar com o Rancher. Para mais informações sobre como obter um token Bearer, veja rancher-admin/users/settings/api-keys.adoc[Criando uma Chave da API].

Autenticação do CLI

Antes de usar o Rancher CLI para controlar seu Servidor Rancher, você deve se autenticar usando um token Bearer da API. Faça login usando o seguinte comando (substitua <BEARER_TOKEN> e <SERVER_URL> com suas informações):

$ ./rancher login https://<SERVER_URL> --token <BEARER_TOKEN>

Se o Rancher Server usar um certificado autoassinado, o Rancher CLI solicitará que você continue com a conexão.

Seleção de Projeto

Antes de executar qualquer comando, você deve selecionar um projeto Rancher para realizar esses comandos. Para selecionar um projeto para trabalhar, use o comando ./rancher context switch. Quando você digitar este comando, uma lista de projetos disponíveis será exibida. Digite um número para escolher seu projeto.

Exemplo: ./rancher context switch Saída*

User:rancher-cli-directory user$ ./rancher context switch
NUMBER    CLUSTER NAME   PROJECT ID              PROJECT NAME
1         cluster-2      c-7q96s:p-h4tmb         project-2
2         cluster-2      c-7q96s:project-j6z6d   Default
3         cluster-1      c-lchzv:p-xbpdt         project-1
4         cluster-1      c-lchzv:project-s2mch   Default
Select a Project:

Após digitar um número, o console exibirá uma mensagem informando que você mudou de projeto.

INFO[0005] Setting new context to project project-1
INFO[0005] Saving config to /Users/markbishop/.ranchcli2.json

Certifique-se de que você pode executar rancher kubectl get pods com sucesso.

Comandos

Os seguintes comandos estão disponíveis para uso no Rancher CLI.

Comando Resultado

Comando	Resultado
`clusters, [cluster]`	Executa operações em seus clusters.
`context`	Alterna entre os projetos do Rancher. Para um exemplo, veja Seleção de Projeto.
`inspect [OPTIONS] [RESOURCEID RESOURCENAME]`	Exibe detalhes sobre recursos do Kubernetes ou recursos do Rancher (ou seja: projetos e cargas de trabalho). Especifique recursos pelo nome ou ID.
`kubectl`	Executa comandos kubectl.
`login, [l]`	Faz login em um Rancher Server. Para um exemplo, veja Autenticação do CLI.
`machines, [machine]`	Realiza operações em máquinas.
`namespaces, [namespace]`	Realiza operações em namespaces.
`nodes, [node]`	Realiza operações em nós.
`projects, [project]`	Realiza operações em projetos.
`ps`	Exibe cargas de trabalho em um projeto.
`server`	Realiza operações para o servidor.
`settings, [setting]`	Mostra as configurações atuais do seu Servidor Rancher.
`ssh`	Conecta-se a um dos nós do seu cluster usando o protocolo SSH.
`up`	Aplica a configuração de compose.
`wait`	Aguarda recursos do cluster, app, projeto, multiClusterApp.
`token`	Autentica e gera um novo token kubeconfig.
`help, [h]`	Mostra uma lista de comandos ou ajuda para um comando.

clusters, [cluster]

Executa operações em seus clusters.

context

Alterna entre os projetos do Rancher. Para um exemplo, veja Seleção de Projeto.

inspect [OPTIONS] [RESOURCEID RESOURCENAME]

Exibe detalhes sobre recursos do Kubernetes ou recursos do Rancher (ou seja: projetos e cargas de trabalho). Especifique recursos pelo nome ou ID.

kubectl

Executa comandos kubectl.

login, [l]

Faz login em um Rancher Server. Para um exemplo, veja Autenticação do CLI.

machines, [machine]

Realiza operações em máquinas.

namespaces, [namespace]

Realiza operações em namespaces.

nodes, [node]

Realiza operações em nós.

projects, [project]

Realiza operações em projetos.

ps

Exibe cargas de trabalho em um projeto.

server

Realiza operações para o servidor.

settings, [setting]

Mostra as configurações atuais do seu Servidor Rancher.

ssh

Conecta-se a um dos nós do seu cluster usando o protocolo SSH.

up

Aplica a configuração de compose.

wait

Aguarda recursos do cluster, app, projeto, multiClusterApp.

token

Autentica e gera um novo token kubeconfig.

help, [h]

Mostra uma lista de comandos ou ajuda para um comando.

Ajuda do Rancher CLI

Uma vez logado no Servidor Rancher usando o CLI, digite ./rancher --help para uma lista de comandos.

Todos os comandos aceitam a flag --help, que documenta o uso de cada comando.

Limitações

O Rancher CLI não pode ser usado para instalar apps de dashboard ou gráficos de recursos do Rancher.