Quickstart para Usuários
Antes de começar
Como Usuário você pode:
- Criar aplicações.
- Registrar aplicações na Runtime Engine.
- Criar/alterar um manifesto Runtimes (oam.yaml), especificando os components da aplicação.
- Fazer o commit/push para iniciar o pipeline da CI (Continuous Integration)/CD (Continuous Delivery).
Sobre o pipeline de CI/CD:
- O CI é responsabilidade da sua Organização.
- O CD é responsabilidade do Runtimes.
- Fazer o deployment da aplicação.
Neste guia rápido, você irá aprender a criar uma aplicação utilizando OAM e a API de Runtimes, e fazer o deployment da aplicação utilizando uma requisição REST.
Criar uma Aplicação
O que é Aplicação em Runtimes
É uma abstração que representa um software. Garante parte das regras de domínio (ou negócio) da empresa, desenhado, desenvolvido e publicado por desenvolvedores.
No contexto StackSpot, a aplicação representa um grupo de componentes, incluindo os recursos de Cloud que executam o software da aplicação e os serviços necessários como bancos de dados e cache.
Confira a seguir como criar, registrar e fazer deploy.
Passo 1. Preencha a especificação da aplicação
Informe os dados e os componentes da sua aplicação. Utilize um dos modelos de template abaixo:
Template de exemplo com a especificação OAM para a sua aplicação
- Template
- Template Simplificado
apiVersion: core.aom.dev/v1beta1
kind: Application
spec:
components:
- name: my-simple-app
type: microservice
properties:
image:
- name:
type:
properties:
apiVersion: core.oam.dev/v1beta1
kind: Application
spec:
components:
- name: my-simple-app
type: microservice
properties:
image: nginx
Passo 2. Enviar sua aplicação para o seu repositório
Faça o commit
das alterações e o push
para o seu repositório.
Nesta etapa se inicia o processo de CI.
O processo de CI é responsabilidade da sua organização. É necessário fazer uma requisição para iniciar o processo de CD aqui, executado pelo Runtimes Engine.
Passo 3. Faça o deploy da aplicação
É uma abstração que representa a publicação de uma aplicação em um ambiente, incluindo o momento (timestamp) e o estado (sucesso, erro). A definição dessa aplicação é descrita utilizando OAM e enviada como parâmetro para a API.
Caso a sua Organização não possua um processo de CI, é possível fazer o registro da aplicação manualmente no Runtimes Engine.
Para fazer o deployment da sua aplicação, siga os passos abaixo:
Registrar Aplicação
Registre a sua aplicação no Runtimes Engine da StackSpot. Confira:
- Em
--data-raw '{"name": "app-name"}'
, preencha oapp-name
com o nome da sua aplicação e execute o comando abaixo:
curl --location --request PUT 'https://runtime-engine-api.runtimes.stackspot.com/apps/' \
--header 'Content-Type: application/json' \
--data-raw '{"name": "app-name"}'
- Anote o
ID
e otargetID
da aplicação que serão retornados. Você precisa deles para executar o deployment.
Executar o deployment
Use o targetID
retornado no registro da sua aplicação, em seguida, em —form ‘’target=“{targetId}”
preencha o targetID
.
Execute o comando abaixo para realizar o deployment pelo terminal:
curl --location --request POST 'https://runtime-engine-api.runtimes.stackspot.com/apps/{appId}/deploys/' \
--header 'Content-Type: multipart/form-data' \
--form 'spec=@"/.application-oam.yml"' \
--form 'target="{targetId}"'
Ao trocar {targetID}
pelo target onde você vai fazer o seu deployment, certifique-se de que você está usando o target correto.
Toda vez que um deployment
for executado, um log
de status é gerado. Este log disponibiliza as seguintes informações:
- Nome da aplicação;
- Status do deployment;
- Passos de tudo o que ocorreu no deployment;
- Componentes aplicados;
- Qual Target foi aplicado.
Para conferir o status do deploy da sua aplicação, faça o login no portal da StackSpot com o e-mail da sua organização e acesse a seção Aplicações.
Esta página foi útil?