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 do Oracle Linux vêm com o pacote de utilitários do OCI (Oracle Cloud Infrastructure) (oci-utils) instalado. Esses 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:

  • O repositório oci_included está ativado. Esse repositório é ativado por padrão nas imagens da plataforma Oracle Linux. O repositório contém todos os pacotes necessários, incluindo os pacotes SDK e Python do OCI necessários. O pacote oci-utils fornece todas as dependências.
  • Os utilitários do OCI têm as permissões necessárias para acessar o Oracle Cloud Infrastructure. Isso pode ser feito 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 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ância adicionando a instância a um grupo dinâmico que tenha 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 conta raiz use arquivos de configuração do OCI de um usuário sem privilégios. Para obter mais informações, consulte o arquivo de configuração no diretório /etc/oci-utils.conf.d da instância.
  • Depois de garantir que os utilitários do OCI tenham as permissões necessárias, selecione qual dos seguintes métodos usar para acessar os utilitários e execute qualquer configuração necessária para esse método:

Para obter um vídeo que mostra como instalar e configurar os utilitários do OCI, consulte Ativando Utilitários do OCI em Instâncias do Oracle Linux no Oracle Cloud Infrastructure.

Atualizando os Utilitários do OCI

Para atualizar para a versão mais recente do oci-utils, execute o seguinte comando:

sudo dnf update oci-utils

Usando o Daemon ocid

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

Para iniciar o daemon ocid imediatamente usando systemd e iniciar automaticamente quando o sistema for inicializado, execute o seguinte comando:

sudo systemctl enable --now ocid.service

Para confirmar se o serviço está ativo (em execução), execute o seguinte comando:

sudo service ocid status

A saída é semelhante à seguinte:

$ 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; preset: disabled)
     Active: active (running) since date and time; 9s ago
 Invocation: edd65c2c534949f3a3fb1a77d0aecccf
   Main PID: 361841 (python3)
      Tasks: 4 (limit: 72765)
     Memory: 127.3M (peak: 127.8M)
        CPU: 1.424s
     CGroup: /system.slice/ocid.service
             └─361841 /usr/bin/python3 /usr/lib/python3.12/site-packages/oci_utils/impl/ocid_main.py --no-daemon
date and time hostname systemd[1]: Starting ocid.service - Oracle Cloud Infrastructure utilities daemon...
date and time hostname systemd[1]: Started ocid.service - Oracle Cloud Infrastructure utilities daemon.

        

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 Configura dispositivos iSCSI anexados a uma instância de computação. Se nenhuma opção da linha de comando for especificada, ela listará quaisquer dispositivos que precisem de atenção.
oci-metadata Exibe metadados para a instância de computação. Se nenhuma opção da linha de comando for especificada, essa opção 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 compartimento ou rede específica.
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 definem ainda qual tipo de informação é produzida pelo utilitário ou como uma tarefa é executada.

A tabela a seguir lista as opções e seus possíveis valores 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 possíveis valores de 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 será exibida. As seguintes opções estão 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ê pode exibir as páginas man de 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