Configurando a CLI
Use o plug-in de linha de comando IBM Cloud Schematics para automatizar o processo de provisionamento de infraestrutura, a configuração de seus recursos e a implementação de cargas de trabalho de aplicativos. A linha de comandos IBM Cloud® Schematics suporta as arquiteturas de plataforma a seguir:
- Mac OS X 64 bits
- Mac OS arm64
- Windows™ 64 bits
- Windows™ 32 bits
- Linux™ 64 bits
- Linux™ arm64
- Linux™ 32 bits
- PowerLinux™ 64 bits
- System/390 Linux™ 64 bits
Instalando a linha de comandos do IBM Cloud
Instale a linha de comandos necessária para começar a usar o IBM Cloud Schematics.
-
Instale a CLI da IBM Cloud.
Planeja usar a linha de comandos muitas vezes? Tente Ativar a conclusão automática do shell para a linha de comandos do IBM Cloud (apenas Linux/MacOS).
-
Efetue login na CLI do IBM Cloud . Insira suas credenciais do IBM Cloud quando solicitadas.
ibmcloud loginSe você tiver um ID federado, use
ibmcloud login --ssopara efetuar login na CLI do IBM Cloud. Insira o seu nome do usuário e use a URL fornecida em sua saída da linha de comandos para recuperar a sua senha descartável. Você sabe que tem um ID federado quando o login falha sem o--ssoe é bem-sucedido com a opção--sso.
Instalando o plug-in da linha de comandos do IBM Cloud Schematics
Instale o plug-in IBM Cloud Schematics para automatizar operações de nuvem, gerenciamento de configuração e implementações de infraestrutura. Também é possível instalar o plug-in do Schematics no Cloud Shell.
-
Instale o plug-in da linha de comandos da IBM Cloud para o Schematics.
ibmcloud plugin install schematics -
Verifique se o plug-in da linha de comandos do IBM Cloud Schematics está instalado com sucesso. Ele estará listado como
schematics.ibmcloud plugin listExemplo de saída
Listing installed plug-ins... Plugin Name Version Status Private endpoints supported schematics[sch] 1.12.28 Update Available true -
Verifique se é possível usar o plug-in da linha de comandos do Schematics listando todos os comandos suportados. O prefixo do comando para trabalhar com o plug-in da linha de comandos do Schematics é
ibmcloud schematics.ibmcloud schematics helpExemplo de saída
NAME: ibmcloud schematics - Automate the deployment and management of IBM Cloud resources using Infrastructure as Code USAGE: ibmcloud schematics command [arguments...] [command options] COMMANDS: action, ac Create and manage Schematics actions. Action let you define the source control repository that contains your playbook yamls etc. and pass environment-specific variables. agent, ag Create and manage agents. Visit 'https://cloud.ibm.com/docs/schematics?topic=schematics-agents-intro' to know more about agents. apply Apply a plan to an workspace to deploy the latest version of your configuration. destroy Destroy resources in an existing workspace. This action cannot be reversed. inventory, iv Create and manage Schematics Inventories. Inventory let you define host group that can contain INI or Resource Query id's job, j Create and manage Schematics jobs. Job let you manage all the jobs like creating/deleting/updating/retrieving. kms listing and enabling IBM Cloud Schematics kms instances and root keys. logs Show details about actions that ran against an workspace. output Get all the output values from your workspace; (ex. result of terraform output command plan Create a plan for an workspace. Plans show how resources would change if you applied the latest version of your workspace configuration. policy, plcy Create and manage policies. Policies tell Schematics which agent it should use to execute Terraform and Ansible jobs in a specific network zone. refresh Refresh the workspace with latest version of your workspace configuration. resource-query, rq Create and manage Schematics Resource Query. Resource query let you define conditions to fetch host group that can be used to perform actions state Advanced state management version Report version information about the IBM Cloud Schematics CLI. workspace, ws Create and manage workspaces. Workspaces let you define the source control repository that contains your Terraform configuration and pass workspace-specific variables. help, h Show help Enter 'ibmcloud schematics help [command]' for more information about a command.
Atualizando a CLI
Atualize a linha de comandos da IBM Cloud e o plug-in da linha de comandos do Schematics periodicamente para obter acesso a novos recursos.
-
Efetue login na CLI do IBM Cloud . Insira suas credenciais do IBM Cloud quando solicitadas.
ibmcloud loginSe você tiver um ID federado, use
ibmcloud login --ssopara efetuar login na CLI do IBM Cloud. Insira o seu nome do usuário e use a URL fornecida em sua saída da linha de comandos para recuperar a sua senha descartável. Você sabe que tem um ID federado quando o login falha sem a opção--ssoe é bem-sucedido com a opção--sso. -
Verifique se uma atualização está disponível para o plug-in da linha de comandos do Schematics. Se uma atualização estiver disponível, você localizará uma notificação Atualização disponível em sua saída da linha de comandos.
ibmcloud plugin list | grep schematicsExemplo de saída
schematics 1.12.28 Update Available false -
Atualize o plug-in da linha de comandos do Schematics.
Para o agente Schematics, a versão do plug-in Schematics deve ser maior que a versão
1.12.12.ibmcloud plugin update schematicsibmcloud plugin list | grep schematicsExemplo de saída
schematics[sch] 1.12.29 true -
Mostrar o plug-in Schematics.
ibmcloud plugin show schematicsExemplo de saída
Plugin Name Version Status Private endpoints supported schematics[sch] 1.12.29 true Commands: schematics,sch Automate the deployment and management of IBM Cloud resources using Infrastructure as Code schematics,sch plan Create a plan for an workspace. Plans show how resources would change if you applied the latest version of your workspace configuration. schematics,sch version Report version information about the IBM Cloud Schematics CLI. schematics,sch logs Show details about actions that ran against an workspace. schematics,sch output Get all the output values from your workspace; (ex. result of terraform output command schematics,sch destroy Destroy resources in an existing workspace. This action cannot be reversed. schematics,sch refresh Refresh the workspace with latest version of your workspace configuration. schematics,sch apply Apply a plan to an workspace to deploy the latest version of your configuration. schematics,sch job,j Create and manage Schematics jobs. Job let you manage all the jobs like creating/deleting/updating/retrieving. schematics,sch job,j run Run a job in IBM Cloud Schematics to work with your Schematics entities like workspaces/actions. schematics,sch job,j get Get information about a job. .... schematics,sch workspace,ws upload Upload a tar file to a workspace from the IBM Cloud Schematics service. schematics,sch workspace,ws commands Run one or more terraform commands schematics,sch workspace,ws taint Marks a Terraform-managed resource as tainted, forcing it to be destroyed and recreated on the next apply schematics,sch workspace,ws untaint Unmarks a Terraform-managed resource as tainted, restoring it as the primary instance in the state schematics,sch workspace,ws state Advanced state management schematics,sch workspace,ws import Run a job to import existing resources into workspace schematics,sch inventory,iv Create and manage Schematics Inventories. Inventory let you define host group that can contain INI or Resource Query id's schematics,sch inventory,iv create Create an Inventory in IBM Cloud Schematics to pass to Schematics action for target host groups schematics,sch inventory,iv update Update an Inventory in IBM Cloud Schematics with all new detail schematics,sch inventory,iv get Get information about an inventory schematics,sch inventory,iv list List all existing inventories in targeted account schematics,sch inventory,iv delete Delete an inventory from the IBM Cloud Schematics service schematics,sch agent,ag Create and manage agents. Visit 'https://cloud.ibm.com/docs/schematics?topic=schematics-agents-intro' to know more about agents. schematics,sch agent,ag create Create an agent in IBM Cloud Schematics. schematics,sch agent,ag validate,plan Run validate to create a prerequisite scan that analyses agent and cluster configuration before deploying your agent. schematics,sch agent,ag deploy,apply Run deploy to deploy your agent on the configured cluster. schematics,sch agent,ag get View the details of an agent. schematics,sch agent,ag list List all agents in your IBM Cloud account. schematics,sch agent,ag update Update your agent details. Updating agent does not re-validate or re-deploy your agent. schematics,sch agent,ag health Run health to perform a health check on your deployed agent. schematics,sch agent,ag delete Delete an agent. schematics,sch agent,ag destroy Destroy the resources associated with agent deployment schematics,sch action,ac Create and manage Schematics actions. Action let you define the source control repository that contains your playbook yamls etc. and pass environment-specific variables. schematics,sch action,ac create Create an action in IBM Cloud Schematics to work with your Ansible configuration in source control. schematics,sch action,ac get Get information about an action. schematics,sch action,ac list List all existing actions in this account. schematics,sch action,ac delete Delete an action from the IBM Cloud Schematics service. schematics,sch action,ac update Update the details of an existing action. schematics,sch action,ac upload Upload TAR file to an action from the IBM Cloud Schematics service
Desinstalando o plug-in da linha de comandos IBM Cloud Schematics
Desinstale o plug-in IBM Cloud Schematics para remover o plugin Schematics a partir do seu sistema local.
-
Desinstale o plug-in da linha de comandos IBM Cloud para Schematics.
ibmcloud plugin uninstall schematicsExemplo de saída
Uninstalling plug-in 'schematics'... OK Plug-in 'schematics' was successfully uninstalled. -
Verifique se o plug-in de linha de comando IBM Cloud Schematics foi desinstalado com êxito.
ibmcloud plugin list | grep schematics