Onboarding
Nesta seção, você encontra um Onboarding na StackSpot EDP.
O que é a StackSpot EDP?
EDP significa Enterprise Developer Platform. É a parte da plataforma da StackSpot feita para criar, padronizar, organizar e fazer o deploy de Aplicações e Infraestruturas.
Na StackSpot EDP, empresas podem criar e distribuir pacotes padronizados de tecnologia (chamados de Stacks) reutilizáveis - como Plugins e Actions - de forma centralizada.
Isso garante a eficiência através da padronização e reuso dos Conteúdos, principalmente Stacks.
Onde acessar a StackSpot EDP?
Você pode acessar a StackSpot EDP de duas formas:
- Portal da StackSpot: interface web para gerenciar e usar todos os recursos da Plataforma.
- STK CLI: ferramenta da linha de comando para criar, configurar e automatizar tarefas.
Para começar,
- Faça o login no Portal da StackSpot EDP com o e-mail da sua empresa.
Se você não conseguir fazer o login e faz parte de uma empresa, entre em contato com o responsável pela Conta da StackSpot na sua organização para solicitar acesso e permissões.
Configuração Inicial (Admin/Account Holder)
Se este é o seu primeiro acesso à StackSpot EDP e você é um Account Holder ou Admin da conta, siga os passos a seguir para configurar o ambiente da sua organização:
1. Escolha o SCM (Source Code Management) da sua empresa:
2. Configure o StackSpot Self-Hosted Workflow com o seu provedor Cloud:
-
Defina como pessoas usuárias da sua organização irão realizar o deploy das Aplicações e Infraestruturas.
Para fazer a configuração, acesse a página de deployment. -
Para orientações detalhadas sobre cada etapa, consulte o guia de configuração inicial.
Fundamentos da StackSpot
A StackSpot EDP funciona como um conjunto de blocos reutilizáveis para desenvolvimento de software.
Cada bloco representa uma tecnologia ou recurso que você combina para criar soluções completas e padronizadas:
- Estúdio = Caixa de brinquedos
O Estúdio é uma caixa que armazena os blocos onde ficam reunidos os diversos grupos de blocos que existem nessa caixa. Estas peças são os Plugins e Actions. Além desses conteúdos, existem as Stacks, as responsáveis por organizar os Plugins, Actions e os Starters.
- Plugin = Blocos de montar
É um dos blocos que representam códigos fonte de Aplicações, podendo ser parte delas, uma base e até mesmo uma Aplicação completa. Ele pode ser de dois tipos: App para Aplicações que envolvem regras de negócio como um CRUD e Infra para recursos de Infraestruturas geradas por Terraform/IaC, como um banco de dados.
É uma peça do bloco de montar, que pode ser encaixada em diferentes construções para dar novas funções. Por exemplo, uma janela, uma porta ou uma roda. Na StackSpot os Plugins de App ajudam a criar as Aplicações e os Plugins de Infra auxiliam na criação de Infraestruturas. E é justamente nos Plugins que está o código das Aplicações e Infraestruturas.
- Action
É um bloco de montar que representa um script. Esse script executa automações para o seu projeto e pode ser escrito em Python ou Shell.
- Stack = conjunto ordenado de tecnologias
A Stack representa um "balde" cheio de peças organizadas para um fim comum e específico. É um agrupamento onde você tem tudo o que precisa para montar vários tipos de construções já separadas por tema ou utilidade, como por exemplo, uma Stack de Angular ou de Java, que ao ser usada, criará uma Aplicação completa de Front-end ou de Back-end.
- Starter = diferentes formas de usar a Stack
O Starter é o "manual de instruções" que vem junto com o balde do bloco de montar, ou seja, a Stack. O Starter é um manual para cada categoria que existe na Stack, e a partir dele você cria algum objeto, como por exemplo Aplicações e Infraestruturas.
- Workflow: um manual que ordena como você deve montar cada peça
O Workflow é o processo de seguir o manual e encaixar as peças, até que tudo esteja pronto. É o fluxo percorrido para transformar as peças soltas em algo funcional. Na StackSpot, o Workflow define a ordem em que os conteúdos (Actions e Plugins) são executados para gerar os recursos solicitados no Portal da StackSpot EDP, como Criar App ou Criar Infra.
- Aplicação/Infraestrutura: um brinquedo pronto
O resultado final é a geração da sua Aplicação ou Infraestrutura. Assim como nas peças dos blocos de montar, este é o momento de ver o brinquedo pronto, funcionando e podendo ser usado por outras pessoas.
Hierarquia dos conteúdos
Existem conteúdos que podem ser criados dentro de um Estúdio, confira:
- Stacks;
- Plugins;
- Actions;
- Starters.
Todo conteúdo fica dentro de uma Stack, que funciona como um organizador ou pacote de conteúdos. Os Starters são diferentes maneiras de usar esse pacote. Por exemplo, você pode ter um Starter que cria uma Aplicação já com banco de dados ou outro que cria sem banco de dados. Assim, você escolhe a opção que melhor atende à sua necessidade.
Jornadas na StackSpot EDP
Criador de Conteúdo
O Criador de Conteúdo na StackSpot é quem cria Plugins, Actions e Stacks publicados em Estúdios.
Pré-requisitos
Possuir um cadastro em:
- Portal da StackSpot EDP: ter uma Conta com permissão específica para a criação dos Conteúdos.
- Ter uma Conta ativa no SCM (GitHub, GitLab, Azure) da sua Organização.
Ter instalado na máquina:
- STK CLI: necessário para fazer a integração com a StackSpot EDP.
- VS Code e SDK da linguagem de programação que você irá criar os códigos.
Conceito essenciais para o Criador
Connection Interface
Connection Interfaces são parâmetros de um recurso AWS que possibilitam sua conexão com outros recursos da Plataforma.
Cada serviço da AWS possui atributos diferentes no cadastro da Connection Interface, criada ao realizar o deploy da Infraestrutura gerada através da plataforma. Dessa forma, qualquer Infraestrutura ou Aplicação compatível com o contrato da Connection Interface pode conectar-se a ela.
Self-Hosted
O Self-Hosted é uma opção que permite que você utilize a StackSpot EDP rodando em servidores próprios da sua empresa, em vez de usar a Infraestrutura em nuvem da StackSpot.
Ou seja, ao invés de depender do ambiente gerenciado pela StackSpot, você pode instalar e executar a Plataforma dentro do seu próprio ambiente (on-premises ou Cloud privada).
Esta configuração é feita somente pela equipe de Site Reliability Engineering (SRE).
Consumidor de Conteúdo
O Consumidor de Conteúdo é quem usa o conteúdo feito e disponibilizado pelos Criadores, representado na figura do Developer/Software Engineer e Tech Leads.
Se você utiliza a StackSpot para desenvolver Aplicações ou Infraestruturas, está usando conteúdos como Plugins e Actions agrupados em Stacks, todos padronizados publicados em Estúdios.
Dessa forma, você pode focar nas funcionalidades da sua Aplicação ou Infraestrutura ao utilizar essas peças tecnológicas pré configuradas e fornecidas pelo time de arquitetos de plataforma (Criadores de Conteúdo) da sua Organização.
Você pode usar apenas os conteúdos disponíveis nas Stacks atribuídas ao seu Workspace pela sua Organização.
Pré-requisitos
Possuir um cadastro em:
- Portal da StackSpot EDP: ter uma Conta com permissão para uso dos Conteúdos.
- Ter uma Conta ativa no SCM (GitHub, GitLab, Azure) da sua Organização. (Confirme com o administrador da sua Conta).
Ter instalado na máquina:
- VS Code e SDK da linguagem de programação que você irá criar os códigos.
1. Criando a sua Aplicação ou Infraestrutura
Uma Aplicação (App) e uma Infraestrutura (Infra) são criadas em fluxos com passos similares, como no exemplo a seguir:
Passo 1. Selecione o Workspace em que você irá criar a sua Aplicação ou Infraestrutura;
Para criar uma App ou Infra você precisa de um Workspace.
Passo 2. Selecione a Stack (e a versão dela) e escolha um Starter;
Passo 3. Adicione um nome e uma descrição para a sua App ou Infra;
Passo 4. Selecione ou crie um repositório;
Passo 5. Adicione Plugins do tipo App ou Infra.
Confira na imagem a seguir a representação deste fluxo de criação de Aplicação e Infraestrutura na StackSpot EDP:
Para conferir os passos completos da criação de uma Aplicação, acesse uma das páginas a seguir:
Já para conferir os passos completos da criação de uma Infraestrutura, acesse uma das páginas a seguir:
2. Deployment das peças de Aplicação ou Infraestrutura
Na StackSpot EDP você consegue fazer o Deploy das suas peças de Infraestrutura (código IAC). Dessa forma, o código da sua Aplicação e Infraestrutura terão as peças de Infraestrutura prontas para uso.
Confira nas páginas a seguir tudo o que você precisa saber sobre deploy na EDP:
- Fazer o Deployment da Aplicação ou Infraestrutura
- Deploy de uma Infraestrutura de Aplicação
- Deploy de uma Infraestrutura
- Deploy de uma Infraestrutura de Aplicação via Runtime Self-Hosted
- Registrar deploy da Aplicação