Introdução à CLI do Code Engine

É possível usar a API do IBM Cloud® Code Engine para criar e gerenciar suas entidades do Code Engine.

Configurando seu ambiente de CLI

Para trabalhar com a CLI para criar e gerenciar entidades do Code Engine, configure seu ambiente da CLI. Certifique-se de ter a versão mais recente da CLI do IBM Cloud instalada.

Antes de Iniciar

Deve-se criar um IBM Cloud conta

  1. Faça download e instale o IBM Cloud CLI.

  2. Efetue login na CLI do IBM Cloud .

    1. Efetue login na CLI do IBM Cloud .
        ibmcloud login
    ```
2. Se você tiver mais de uma conta, será solicitado que selecione qual conta será usada. Siga os prompts ou use o comando **`target`** para selecionar sua conta do IBM Cloud.

```txt {: pre}
    ibmcloud target -c <account_id>
    ```
3. Especifique uma região. Use o **`target`** comando para selecionar ou alterar regiões.

```txt {: pre}
    ibmcloud target -r <region>
    ```
4. Especifique um grupo de recursos. Para obter uma lista de seus grupos de recursos, execute o comando a seguir.

```txt {: pre}
    ibmcloud resource groups
    ```
    Saída de exemplo

    ```txt {: screen}
    Retrieving all resource groups under account <account_id> as email@ibm.com...
    OK
    Name      ID                                 Default Group   State   
    default   a8a12accd63b437bbd6d58fb8b462ca7   true            ACTIVE
    test      a8a12abbbd63b437cca6d58fb8b462ca7  false           ACTIVE
    ```
5. Direcione um grupo de recursos executando o comando a seguir.

```txt {: pre}
    ibmcloud target -g <resource_group>
    ```
    Saída de exemplo

    ```txt {: screen}
    Targeted resource group default
    ```

  3. Instale o plug-in da CLI do Code Engine.

    ibmcloud plugin install code-engine

  4. Verifique se o plug-in da CLI do Code Engine está instalado. É possível usar o comando ibmcloud code-engine version ou o comando ibmcloud plugin list para confirmar que o plug-in está instalado

    ibmcloud code-engine version

    Saída de exemplo

    OK
version:  v1.54.2
commit:   e4800be63b1077563bdbaee9e656ce1f81c3e08d

  5. Execute o comando ibmcloud ce help para visualizar os comandos da CLI do Code Engine. Por exemplo,

    ibmcloud ce help

Trabalhando com a CLI do Code Engine

Agora que seu ambiente da CLI do Code Engine está configurado, você está pronto para trabalhar com os recursos do Code Engine, como aplicativos, funções ou tarefas com a CLI.

Antes de poder trabalhar com recursos do Code Engine, deve-se trabalhar no contexto de um projeto.

Um projeto é um agrupamento de entidades d Code Engine, como aplicativos, funções, tarefas, frotas e compilações. Um projeto é baseado em um namespace do Kubernetes. O nome de seu projeto deve ser exclusivo dentro de seu grupo de recursos, sua conta do usuário e sua região do IBM Cloud®. Os projetos são utilizados para gerenciar recursos e fornecer acesso às suas entidades.

Um projeto oferece os seguintes recursos:

  • Um namespace exclusivo para nomes de entidades.
  • Gerenciamento do acesso de terceiros aos recursos do projeto.
  • Gerenciamento do acesso externo a serviços de suporte, registros e repositórios.
  • Um certificado gerado automaticamente para o Serviço da Camada de Transporte ( TLS ).

Para obter mais informações sobre projetos Code Engine, consulte Gerenciando projetos.

  1. Crie um projeto com o comando project create. Use um nome de projeto que seja exclusivo para sua região.

    ibmcloud ce project create --name PROJECT_NAME

    Saída de exemplo

    Creating project 'myproject'...
OK

  2. Visualize detalhes sobre o projeto com o comando project get.

    ibmcloud ce project get --name PROJECT_NAME

    Saída de exemplo

    Getting project 'myproject'...
OK
Name:                       myproject
ID:                         01234567-abcd-abcd-abcd-abcdabcd1111
Status:                     active
Selected:                   true
Region:                     us-south
Resource Group:             default
Service Binding Service ID: ServiceId-1234abcd-abcd-abcd-1111-1a2b3c4d5e6f
Age:                        52d
Created:                    Fri, 15 Jan 2021 13:32:30 -0500
Updated:                    Fri, 15 Jan 2021 13:32:45 -0500
Quotas:
Category                                  Used      Limit
App revisions                             1         100
Apps                                      1         100
Build runs                                0         100
Builds                                    0         100
Configmaps                                2         100
CPU                                       1.025     64
Ephemeral storage                         902625Ki  256G
Instances (active)                        1         250
Instances (total)                         2         2500
Job runs                                  1         100
Jobs                                      1         100
Memory                                    4400M     256G
Secrets                                   5         100
Subscriptions (cron)                      0         100
Subscriptions (IBM Cloud Object Storage)  0         100

Como alternativa, é possível usar o comando project list para exibir uma lista de projetos criados.

Para trabalhar com um projeto com a CLI, o projeto deve ser selecionado como o contexto atual. Um projeto é selecionado automaticamente como o contexto atual quando ele é criado, a menos que você especifique a opção --no-select. Para selecionar um projeto que não seja atualmente visado, use o comando project select.

Para obter mais informações sobre como trabalhar com projetos, consulte Gerenciando projetos.

Próximas etapas

Agora que você configurou seu ambiente da CLI e tomou as primeiras etapas para assegurar que esteja trabalhando no contexto de um projeto Code Engine, é possível usar a CLI do Code Engine para trabalhar com apps, funções e tarefas.

Para começar a trabalhar com componentes Code Engine com a CLI, consulte os tópicos a seguir.

Para obter mais informações sobre a CLI do Code Engine, consulte a Configurando o ambiente da CLI.

Para obter mais informações sobre como trabalhar no ambiente da CLI do Code Engine, consulte Code Engine Documentação de referência de comando da CLI.

Para obter um resumo das alterações para cada versão da CLI, consulte Histórico da Versão da CLI Certifique-se de manter sua CLI atualizada para que seja possível utilizar todos os comandos disponíveis e suas opções.