Configuración de la CLI

Utilice el complemento de comando IBM Cloud Schematics para automatizar el proceso de aprovisionamiento de la infraestructura, la configuración de sus recursos y la implantación de cargas de trabajo de aplicaciones. La línea de mandatos IBM Cloud® Schematics da soporte a las siguientes arquitecturas de plataforma:

  • Mac OS X de 64 bits
  • Mac OS arm64
  • Windows™ de 64 bits
  • Windows™ de 32 bits
  • Linux™ de 64 bits
  • Linux™ arm64
  • Linux™ de 32 bits
  • PowerLinux™ de 64 bits
  • System/390 Linux™ de 64 bits

Instalación de la línea de mandatos de IBM Cloud

Instale la línea de mandatos necesaria para empezar a utilizar IBM Cloud Schematics.

  1. Instale la CLI de IBM Cloud.

    ¿Tiene pensado utilizar la línea de mandatos con frecuencia? Pruebe a habilitar la terminación automática del shell para la línea de mandatos de IBM Cloud (solo Linux/MacOS).

  2. Inicie una sesión en la CLI de IBM Cloud. Escriba sus credenciales de IBM Cloud cuando se le solicite.

    ibmcloud login
    

    Si tiene un ID federado, utilice ibmcloud login --sso para iniciar la sesión en la CLI de IBM Cloud. Especifique su nombre de usuario y utilice el URL proporcionado en la salida de la línea de mandatos para recuperar el código de acceso de un solo uso. Sabe si tiene un ID federado cuando el inicio de sesión falla sin --sso y se lleva a cabo correctamente con la opción --sso.

Instalación del plugin de línea de mandatos de IBM Cloud Schematics

Instale el complemento IBM Cloud Schematics para automatizar las operaciones en la nube, la gestión de la configuración y las implantaciones de infraestructura. También puede instalar el plugin Schematics en Cloud Shell.

  1. Instale el plugin de línea de mandatos de IBM Cloud para Schematics.

    ibmcloud plugin install schematics
    
  2. Verifique que el plugin de línea de mandatos de IBM Cloud Schematics se ha instalado correctamente. El plugin aparece como schematics.

    ibmcloud plugin list
    

    Salida de ejemplo

    Listing installed plug-ins...
    
    Plugin Name                             Version      Status             Private endpoints supported
    schematics[sch]                           1.12.28   Update Available                     true
    
  3. Verifique que puede utilizar el plugin de línea de mandatos de Schematics visualizando una lista de todos los mandatos admitidos. El prefijo de mandato para trabajar con el plugin de línea de mandatos de Schematics es ibmcloud schematics.

    ibmcloud schematics help
    

    Salida de ejemplo

    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.
    

Actualización de la CLI

Actualice la CLI de IBM Cloud y el plugin de línea de mandatos de Schematics periódicamente para obtener acceso a nuevas características.

  1. Actualice la CLI de IBM Cloud.

  2. Inicie una sesión en la CLI de IBM Cloud. Escriba sus credenciales de IBM Cloud cuando se le solicite.

    ibmcloud login
    

    Si tiene un ID federado, utilice ibmcloud login --sso para iniciar la sesión en la CLI de IBM Cloud. Especifique su nombre de usuario y utilice el URL proporcionado en la salida de la línea de mandatos para recuperar el código de acceso de un solo uso. Sabe que tiene un ID federado cuando el inicio de sesión falla sin el --sso y se lleva a cabo correctamente con la opción --sso.

  3. Compruebe si hay una actualización disponible para el plugin de línea de mandatos de Schematics. Si hay una actualización disponible, encontrará una notificación de Actualización disponible en la salida de la línea de mandatos.

    ibmcloud plugin list | grep schematics
    

    Salida de ejemplo

    schematics                      1.12.28        Update Available           false
    
  4. Actualice el plugin de línea de mandatos de Schematics.

    Para el agente Schematics, la versión del plug-in Schematics debe ser mayor que la versión de 1.12.12.

    ibmcloud plugin update schematics
    
    ibmcloud plugin list | grep schematics
    

    Salida de ejemplo

    schematics[sch]                      1.12.29        true
    
  5. Muestra el plugin Schematics.

    ibmcloud plugin show schematics
    

    Salida de ejemplo

    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
    

Desinstalación del plug-in de línea de mandatos IBM Cloud Schematics

Desinstale el plugin IBM Cloud Schematics para eliminar el plugin Schematics del sistema local.

  1. Desinstale el plugin de línea de mandatos IBM Cloud para Schematics.

    ibmcloud plugin uninstall schematics
    

    Salida de ejemplo

    Uninstalling plug-in 'schematics'...
    OK
    Plug-in 'schematics' was successfully uninstalled.
    
  2. Compruebe que el complemento de comando IBM Cloud Schematics se ha desinstalado correctamente.

    ibmcloud plugin list | grep schematics