Utilitários do OCI

As instâncias que usam imagens da plataforma Oracle Linux incluem um conjunto de utilitários (oci-utils) que permitem que a instância acesse informações sobre recursos de infraestrutura. Esses utilitários consistem em um componente de serviço e em ferramentas de linha de comando que ajudam a descobrir ou provisionar recursos automaticamente.

Instalando os Utilitários do OCI

As instâncias iniciadas com Oracle Linux 7 ou posterior incluem automaticamente o pacote dos utilitários (oci-utils) do Oracle Cloud Infrastructure (OCI) instalado. Os utilitários não estão disponíveis em outras distribuições.

Para usar os utilitários do OCI, você deve atender aos seguintes pré-requisitos:

  • Certifique-se de que o repositório oci_included esteja ativado. Esse repositório é ativado por padrão nas imagens da plataforma Oracle Linux. Este repositório contém todas as dependências de pacote, incluindo os pacotes SDK e Python do OCI necessários. Todos os pacotes necessários são instalados com o pacote oci-utils.
  • Certifique-se de que os utilitários do OCI tenham permissões suficientes para acessar o Oracle Cloud Infrastructure executando um dos seguintes procedimentos:
    • Crie o arquivo de configuração do SDK para o host. Para obter mais informações, consulte Arquivo de Configuração da CLI e de SDKs.
      Observação

      Talvez seja necessário instalar a CLI do seu ambiente antes de executar o comando oci setup config para criar o arquivo de configuração do SDK. Para obter mais informações, consulte Instalando a CLI.
    • Use controladores de instâncias adicionando a instância a um grupo dinâmico que recebeu acesso aos serviços do Oracle Cloud Infrastructure. Para obter mais informações, consulte Gerenciando Grupos Dinâmicos.
    • Configure oci-utils para permitir que a raiz use os arquivos de configuração do Oracle Cloud Infrastructure de um usuário não privilegiado. Para obter mais informações, consulte o arquivo de configuração localizado no diretório /etc/oci-utils.conf.d da instância.
  • Escolha o método para acessar os utilitários e execute qualquer procedimento de configuração para esse método, conforme necessário:

Para obter um vídeo sobre como instalar e configurar os utilitários do OCI, consulte Enabling OCI Utilities in Oracle Linux on Oracle Cloud Infrastructure Instance na Oracle Linux Training Station.

Atualizando os Utilitários do OCI

Para atualizar para a versão mais recente do oci-utils:

sudo yum update oci-utils

Usando o Daemon ocid

O daemon ocid é o componente de serviço do oci-utils. Ele monitora alterações na configuração VNIC e iSCSI da instância e tentará anexar ou desanexar automaticamente os dispositivos à medida que eles aparecem ou desaparecem - por exemplo, quando eles forem criados ou excluídos usando a Console, a CLI ou o API do Oracle Cloud Infrastructure.

Para iniciar o daemon ocid usando systemd e definir o serviço ocid para iniciar automaticamente durante a inicialização do sistema:

sudo systemctl enable --now ocid.service

Para confirmar se o serviço está ativo (em execução):

sudo service ocid status

Por exemplo:

$ sudo service ocid status
Redirecting to /bin/systemctl status ocid.service
  ocid.service - Oracle Cloud Infrastructure utilities daemon
   Loaded: loaded (/etc/systemd/system/ocid.service; enabled; vendor preset: enabled)
   Active: active (running) since Thu 2021-02-04 18:01:25 GMT; 1min 42s ago
 Main PID: 16630 (python3)
   CGroup: /system.slice/ocid.service
           └─16630 /usr/bin/python3 /usr/lib/python3.6/site-packages/oci_util...

Feb 04 18:01:23 mor-demoinst-10 systemd[1]: Starting Oracle Cloud Infrastruc....
Feb 04 18:01:24 mor-demoinst-10 sudo[16705]:     root : TTY=unknown ; PWD=/ ...w
Feb 04 18:01:25 mor-demoinst-10 systemd[1]: Started Oracle Cloud Infrastruct....
Hint: Some lines were ellipsized, use -l to show in full.
        

Resumo de Utilitários do OCI

Um resumo dos componentes de utilitários do OCI.

Nome Descrição
ocid O componente de serviço do oci-utils, que é executado como daemon iniciado por systemd. Esse serviço procura alterações nas configurações de dispositivos iSCSI e VNIC e armazena em cache os metadados e o endereço IP público da instância.
oci-compartmentid Exibe o OCID (Oracle Cloud Identifier) do compartimento no qual a instância está sendo executada.
oci-growfs Expande o Sistema de Arquivos Raiz da Instância para seu tamanho configurado.
oci-image-expand Converte a instância Mínima do Oracle Linux para adicionar serviços e pacotes de uma imagem de plataforma padrão do Oracle Linux.
oci-instanceid Exibe o OCID da instância.
oci-iscsi-config Lista ou configura dispositivos iSCSI anexados a uma instância de computação. Se nenhuma opção de linha de comando for especificada, listará os dispositivos que precisam de atenção.
oci-metadata Exibe metadados para a instância de computação. Se nenhuma opção de linha de comando for especificada, listará todos os metadados disponíveis. Os metadados incluem o OCID da instância, o nome para exibição, o compartimento, a forma, a região, o domínio de disponibilidade, a data de criação, o estado, a imagem e quaisquer metadados personalizados que você fornecer, como uma chave pública SSH.
oci-network-config Lista ou configura VNICs (placas de interface de rede virtual) anexadas à instância de computação. Quando uma VNIC secundária é provisionada na nuvem, ela deve ser configurada explicitamente na instância usando esse script ou comandos semelhantes.
oci-network-inspector Exibe um relatório detalhado de um determinado compartimento ou rede.
oci-notify Envia uma mensagem para um tópico do serviço Notifications.
oci-public-ip Exibe o endereço IP público do sistema atual em formato JSON ou legível.
oci-volume-data Exibe dados sobre um volume iSCSI específico anexado à instância.

Opções Comuns do Utilitário OCI

Muitos dos utilitários da Oracle Cloud Infrastructure (OCI) têm as mesmas opções ou argumentos disponíveis quando os utilitários são executados na linha de comando. Essas opções e argumentos ajudam a definir melhor que tipo de informação é produzida pelo utilitário ou como uma tarefa do utilitário é executada.

A tabela a seguir lista as opções e seus valores suportados comuns nos utilitários do OCI.

Opção Descrição
--help Exibe informações de ajuda sobre o utilitário, como o uso do utilitário, as opções disponíveis e os valores suportados para cada opção. Por exemplo, para exibir a ajuda do utilitário oci-metadata:
$ sudo oci-metadata --help

usage: oci-metadata [-h] [-j] [-g KEY] [--value-only] [--export] [--trim]
                    [-u KEY=VALUE  [KEY=VALUE  ...]] [-i OCID] [--help]

Utility for displaying metadata for an instance running in the Oracle Cloud
Infrastructure.

optional arguments:
  -h, --human-readable  Display human readable output (default)
  -j, --json            Display json output
  ...
  --help                Display this help

--all

Mostra todos os itens, ou valores, na saída.

--details

Mostra informações detalhadas na saída.

--output-mode

Permite que você defina como a saída do utilitário será exibida. Veja a seguir os modos de utilitário do OCI disponíveis:

  • json: Exibe a saída no formato JSON.
  • human-readable: Exibe a saída em formato legível humano.
  • parsable: Exibe a saída em formato analisável.
  • table: Exibe a saída em uma tabela.
  • text: Exibe a saída textual.

--no-truncate

Não encurta os valores na saída exibida.

--truncate

Diminui os valores na saída exibida.

-y| --yes

Responde "sim" em todos os prompts.

-n | --no

Respostas "não" em todos os prompts.

-q | --quiet

Suprime mensagens de informação.

Observação

Você também pode exibir páginas man para cada utilitário do OCI digitando man oci-utility na linha de comando. Por exemplo, para exibir as páginas manuais incorporadas do utilitário oci-metadata:
man oci-metadata