Troubleshooting
Nesta seção, você encontra a solução para erros na StackSpot.
Confira os possíveis erros que você pode ter ao utilizar a StackSpot e como você pode resolvê-los:
Problemas
Não consigo aplicar um Plugin no meu Workspace
Solução: Teste novamente seguindo os passos:
Passo 1. Adicionar as linhas no final do seu arquivo .zshrc
:
export PATH=$HOME/.stk/bin:$PATH
test -f ~/.stk/bin/.zshrc && . ~/.stk/bin/.zshrc
Passo 2. Reiniciar o seu terminal;
Passo 3. Executar o comando:
stk -v
Problema: Não consigo aplicar um Plugin no meu Workspace
Solução: Para aplicar Plugin em um Workspace:
- No seu terminal, entre no seu Workspace e execute:
stk use workspace workspace-name
- Aplique o Plugin, executando:
stk apply plugin studio-name/stack-name/plugin-name
- Para aplicar um Plugin fora do Workspace, execute:
stk apply plugin account/studio/plugin@1.0.0
Para saber em qual Workspace você está, execute:
stk list workspace
O seu Workspace terá um asterisco.
No Windows 10 e 11: Erro ao baixar o .msi e tentar instalar
Solução: Executar o comando:
msiexec /i stk.msi
Criar App via Portal:"Waiting for Git provider workflow"". Pending"
Solução
Ao criar uma aplicação via Portal, o status do Workflow não é atualizado, mesmo mostrando sucesso no Git.
Para funcionar, você precisa configurar um webhook, confira os passos na seção de
STK CLI
ERRO: STACK_NOT_FOUND_IN_WORKSPACE x Stack NOME Não faz parte do workspace atual.
Solução
- Se você está em um Workspace, é necessário no seu terminal seguir com: studio-name/stack-name/plugin-name
- Se está fora de um Workspace, utilize: account-name/studio-name/
Para saber em qual Workspace você está, execute: stk list workspace
O Workspace que você está terá um asterisco.
Para entrar em um Workspace, execute o comando: stk use workspace workspace-name
Para sair do Workspace: stk exit workspace
ERRO: WORKSPACE_FORBIDDEN_ERROR x Você não tem permissão para usar esse workspace!
Solução
Você não tem um Workspace configurado para o uso. Procure o admin da sua conta Enterprise.
E se quiser, você pode usar Starters e Plugins diretamente de um Estúdio.
ERRO: CREATE_PLUGIN x [WinError 5] Acesso negado
Solução
Reinicie o Bash.
Instalação Linux: dpkg: error processing archive stk.deb (--install)
Solução:
- Execute o comando:
curl -fsSL https://stk.stackspot.com/install.sh | bash
- Siga os passos na seção de Instalação.
Aplicar Plugin local (com Path) via STK CLI: INVALID_PLUGIN_QUALIFIED_NAME x Invalid plugin name! Must follow the format: account/studio/plugin-name[@version]
Solução
-
Verifique se a pasta selecionada no Path é, de fato, um Plugin (com o plugin.yaml dentro);
-
Copie o Path e insira ele entre aspas no comando do
stk apply plugin
.
Exemplo:
stk apply plugin “C:/User/Meus-projetos/Meu-plugin”
ERRO: ACTIONAPI_0003_INVALID_WORKFLOW_URL
Solução
Verifique, no cadastro do seu SCM, se a URL informada segue um dos padrões:
- GitHub:
^https://github.com/[a-zA-Z0-9-_%]*/[a-zA-Z0-9-_%]*$
- Azure:
^https://dev.azure.com/[a-zA-Z0-9-_]*/[a-zA-Z0-9-_%]*$
- Bitbucket:
^https://bitbucket.org/[a-zA-Z0-9-_]*/[a-zA-Z0-9-_%]*$
- GitLab:
^https://gitlab.com/[a-zA-Z0-9-_]*/[a-zA-Z0-9-_%]*\?project_id=[0-9]*&trigger_id=[0-9]*$
ERRO: ACTIONAPI_5001_GITHUB_DISPATCH_WORKFLOW_NOT_FOUND x Workflow not found
Solução
-
O Workflow não foi configurado em sua Organização. Utilize a Action de configuração de Workflows para criar o arquivos necessários em sua Organização.
-
O token do SCM configurado na conta da StackSpot não tem acesso para visualizar o repositório em que o Workflow está configurado. Confira se a sua conta tem permissão para isso.
ERRO: ACTIONAPI_5004_GITHUB_SAML_ERROR x Unauthorized token by the organization
Solução
Se a sua organização possuir o login via SSO (Single Sign On) configurado, autorize o seu Token:
- No GitHub, acesse 'Settings'
- Clique em 'Developer Settings'
- No seu token, clique em 'Configure SSO':
Em seguida, consulte se o seu token foi autorizado conforme o exemplo:
Para mais informações sobre o Personal Access Token, consulte a documentação do Github.
ERRO: ACTIONAPI_5020_GITHUB_APP_INSTALLATION_ACCESS_TOKEN_FAILURE x A problem happened calling github
Solução
Verifique a saúde da conexão do workflow.
ERRO: ACTIONAPI_5021_GITHUB_APP_INSTALLATION_ACCESS_TOKEN_NOT_FOUND x installation not found
Solução
Confira se o install id
informado na tela de cadastro SCM é válido.
ERRO: ACTIONAPI_5022_GITHUB_APP_INSTALLATION_ACCESS_TOKEN_UNAUTHORIZED x Unauthorized to get installation access token
Solução
Verifique se a private key
informada tem acesso ao install id
informado.
ERRO: ACTIONAPI_E5122_ACCOUNT_SERVICE_GET_USER_SCM_NOT_FOUND x User scm not found
Solução
Confira, nas Configurações de Workflow, se toggle da configuração do SCM está ativado.
ERRO: ACTIONAPI_5201_AZURE_LIST_PIPELINE_NOT_FOUND x Pipeline not found
Solução
Utilize a Action de configuração para criar a pipeline na sua conta Azure.
ERRO: ACTIONAPI_5202_AZURE_LIST_PIPELINE_UNAUTHORIZED x Unauthorized to list pipelines
Solução
O PAT informado não possui as permissões necessárias para listagem de pipelines na Azure. Adicione a permissão ao PAT.
ERRO: ACTIONAPI_5212_AZURE_RUN_PIPELINE_UNAUTHORIZED x Unauthorized to run pipelines
Solução
O PAT informado não possui as permissões necessárias para listagem de pipelines na Azure. Adicione a permissão ao PAT.
ERRO: ACTIONAPI_5401_BITBUCKET_RUN_PIPELINE_NOT_FOUND x Pipeline not found
Solução
A pipeline não foi criado em sua conta Bitbucket. Utilize a Action de configuração para criar a pipeline.
ERRO: ACTIONAPI_5402_BITBUCKET_RUN_PIPELINE_UNAUTHORIZED x Unauthorized to trigger pipeline
Solução
O PAT informado não possui as permissões necessárias para execução de pipelines no Bitbucket. Adicione a permissão ao PAT.
ERRO: ACTIONAPI_5501_GITLAB_TRIGGER_PIPELINE_NOT_FOUND x Pipeline not found
Solução
A pipeline não foi criada em sua conta GitLab. Utilize a Action de configuração para criar a pipeline.
ERRO: ACTIONAPI_5502_GITLAB_TRIGGER_PIPELINE_UNAUTHORIZED x Trigger token is not authorized to trigger pipeline
Solução
O PAT cadastrado não possui as permissões necessárias para fazer consulta no token do trigger da pipeline. Adicione a permissão ao PAT.
ERRO: ACTIONAPI_5512_GITLAB_GET_TRIGGERS_UNAUTHORIZED x Unauthorized to get trigger token
Solução
O PAT informado não tem acesso para buscar o trigger token
informado na tela de cadastro do SCM.
ERRO: ACTIONAPI_2105_BAD_REQUEST_INVALID_REPO_URL
Solução
O repository url
não corresponde ao regex permitido de acordo com o provedor configurado.
ERRO: ERRO: Found xterm, while expecting a Windows console
Solução
Durante a instalação do Git (Windows, Mac ou Linux), adicione a informação sobre a ativação do suporte experimental para pseudo-consoles.
Plugins
Confira os principais erros que podem acontecer durante a Criação ou Publicação de um Plugin.
Código | Descrição | Quando acontece |
---|---|---|
PLUGINAPI_1000_PLUGIN_NOT_FOUND | Plugin não encontrado. | O Plugin não existe ou o usuário não tem acesso para visualizar o Plugin. |
PLUGINAPI_1002_PLUGIN_ALREADY_EXISTS | Versão do Plugin já existe. | Quando tenta publicar uma versão de um Plugin já publicado. Por regra de negócio, a versão de um Plugin é imutável. |
PLUGINAPI_1013_SAVE_ZIP_TMP_ERROR | Erro ao salvar o zip. | Caso aconteça, o suporte será acionado, já que ele é um step transparente pro usuário. |
PLUGINAPI_1015_INVALID_TYPE_ERROR | Mudança não permitida do type ao publicar uma versão. | Quando tenta publicar uma versão com um type diferente das versões anteriormente publicadas. Por regra de negócio, o type de um Plugin é imutável. |
PLUGINAPI_2000_BAD_REQUEST | Dados da requisição inválido. | Requisição mal formatada. |
PLUGINAPI_5000_UNEXPECTED_ERROR | Algum erro inesperado. | Erro não tratado. Caso aconteça, o suporte será acionado, já que ele é um step transparente pro usuário. |
Interpolação com Jinja
Não quero que um trecho de código do meu arquivo seja interpolado pelo Jinja, preciso manter o conteúdo original. Como resolver?
Solução
Adicione na estrutura do seu código:
{%raw%}
E o conteúdo a ser ignorado pelo Jinja:
{%endraw%}
Busca (Search Engine)
Problema: O que é o erro 403 que aparece quando eu clico em um item que apareceu em uma busca no Portal StackSpot?
Na lista de busca, você pode ver todos os itens encontrados de acordo com o termo que você digitou. Mas se você não tiver permissão para acessá-los, ao clicar nele o servidor irá retornar um erro 403.
Solução
Verifique com o seu Account Holder, o responsável por gerenciar papéis e Permissões, se você pode ter acesso a este conteúdo.
plugin.yaml
e action.yaml
Problema: plugin/action '{slug}'
passou por mudanças significativas que podem afetar sua compatibilidade. Detalhes: "The new version needs to be a major version because the schema version has been changed"
Acontece quando há um erro no schema version de duas versões de um plugin.yaml
, em que não há mudança na Major.
Confira o exemplo a seguir em que o schema version mudou de v2 para v3:
- Arquivo
.yaml
na versão v2:
schema-version: v2
- Arquivo
.yaml
na versão v3:
schema-version: v3
Solução
Publicar uma nova versão Major do plugin.yaml
.
Problema: plugin/action '{slug}'
passou por mudanças significativas que podem afetar sua compatibilidade. Detalhes: "The new version needs to be a major version because a required Plugin has been either added or removed"
Esse erro acontece em cenários de adição e remoção de Plugins que foram definidos como requisito para outros Plugins.
Confira o exemplo a seguir em que o plugin studio-it-3/plugin-4
foi adicionado:
- Arquivo
.yaml
em uma versão anterior:
spec:
requires:
plugins:
- studio-it-2/plugin-1
- Arquivo
.yaml
em uma versão atualizada:
spec:
requires:
plugins:
- studio-it-2/plugin-1
- studio-it-3/plugin-4
Solução
Publicar uma nova versão Major do plugin.yaml
.
Problema: plugin/action '{slug}'
passou por mudanças significativas que podem afetar sua compatibilidade. Detalhes: "The new version needs to be a major version because a required Action has been either added or removed"
O erro acontece em cenários de adição e remoção de Actions que foram definidas como requisitos.
Confira o exemplo a seguir em que houve a remoção da Action studio-it-2/action-docker-3
:
- Arquivo
.yaml
em uma versão anterior:
spec:
requires:
actions:
- studio-it-2/action-container-1
- studio-it-2/action-docker-3
- Arquivo
.yaml
em uma versão atualizada:
spec:
requires:
actions:
- studio-it-2/action-container-1
Solução
É preciso publicar uma nova versão Major da action.yaml
.
Problema: plugin/action '{slug}'
passou por mudanças significativas que podem afetar sua compatibilidade. Detalhes: "The new version needs to be a major version because a Connection Interface in the required section has been either added or removed."
O erro acontece em cenários de adição e remoção de Connection Interface requerida em um Plugin.
Confira o exemplo a seguir em que houve a remoção de um input do tipo required-connection
com uma Connection Interface do tipo connection aws-rds-conn
:
- Arquivo
.yaml
em uma versão anterior:
spec:
inputs:
- label: Connection Interface for connection alias-0.
name: alias-0
type: required-connection
connection-interface-type: aws-eks-conn
- label: Connection Interface for connection alias-1.
name: alias-1
type: required-connection
connection-interface-type: aws-rds-conn
- Arquivo
.yaml
em uma versão atualizada:
spec:
inputs:
- label: Connection Interface for connection alias-0.
name: alias-0
type: required-connection
connection-interface-type: aws-eks-conn
Solução
Publicar uma nova versão Major do plugin.yaml
.
Problema: plugin/action '{slug}'
passou por mudanças significativas que podem afetar sua compatibilidade. Detalhes: "The new version needs to be a major version because a Connection Interface in the generates section has been either added or removed"
O erro acontece em cenários de adição e remoção de Generates de Connection Interface.
Confira o exemplo a seguir em que houve uma adição da generates de connection aws-s3-conn
:
- Arquivo
.yaml
em uma versão anterior:
spec:
generates:
connections:
- type: aws-ecr-conn
selected: plugin-registry-ecr
alias: aws-ecr-conn
- Arquivo
.yaml
em uma versão atualizada:
spec:
generates:
connections:
- type: aws-ecr-conn
selected: plugin-registry-ecr
alias: aws-ecr-conn
- type: aws-s3-conn
selected: content-registry-bucket
alias: aws-s3-bucket-conn
Solução
Publicar uma nova versão Major do plugin.yaml
.
Problema: plugin/action '{slug}'
passou por mudanças significativas que podem afetar sua compatibilidade. Detalhes: "The new version needs to be a major version because an input has been either added or removed"
Esse erro acontece em cenários de adição e remoção de Inputs.
Confira o exemplo a seguir em que houve a remoção do input resource
:
- Arquivo
.yaml
em uma versão anterior:
spec:
inputs:
- label: label 0
name: resource
type: text
required: true
default: hue 1
pattern: '[a-z]+'
help: 'Inform your resource name (e.g.: Client)'
- label: label 1
name: select_field
type: text
required: true
default: Item1
external-items:
source: https://my-mock-api.com/listItems
value: $[*].id
label: $[*].name
items:
- Item1
- Item2
- Item3
- Arquivo
.yaml
em uma versão atualizada:
spec:
inputs:
- label: label 1
name: select_field
type: text
required: true
default: Item1
external-items:
source: https://my-mock-api.com/listItems
value: $[*].id
label: $[*].name
items:
- Item1
- Item2
- Item3
Solução
Publicar uma nova versão Major do plugin.yaml
ou da action.yaml
.
Problema: plugin/action '{slug}'
passou por mudanças significativas que podem afetar sua compatibilidade. Detalhes:"The new version needs to be a major version because the type of an existing input has been edited"
O erro acontece em cenários de publicação de tipos de Inputs.
Confira o exemplo a seguir em que houve troca do tipo do input de text
para bool
:
- Arquivo
.yaml
em uma versão anterior:
spec:
inputs:
- label: label 1
name: select_field
type: text
required: true
default: Item1
external-items:
source: https://my-mock-api.com/listItems
value: $[*].id
label: $[*].name
items:
- Item1
- Item2
- Item3
- Arquivo
.yaml
em uma versão atualizada:
spec:
inputs:
- label: label 1
name: select_field
type: bool
required: true
default: Item1
external-items:
source: https://my-mock-api.com/listItems
value: $[*].id
label: $[*].name
items:
- Item1
- Item2
- Item3
Solução
Publicar uma nova versão Major do plugin.yaml
ou da action.yaml
.
Problema: plugin/action '{slug}'
passou por mudanças significativas que podem afetar sua compatibilidade. Detalhes: "The new version needs to be a major version because a sub input in an input has been either added or removed"
O erro acontece em cenários de publicação de subtipos de Inputs.
Confira o exemplo a seguir em que houve a remoção do subinput
host
:
- Arquivo
.yaml
em uma versão anterior:
spec:
type: python
docs:
pt-br: docs/pt-br.md
inputs:
- type: object
name: firewall_rule
label: Informe o CIDR/Porta da regra de firewall
inputs:
- type: text
name: cidr
label: CIDR
pattern: '^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}/\d{2}$'
- type: int
name: port
label: Porta
- Arquivo
.yaml
em uma versão atualizada:
spec:
type: python
docs:
pt-br: docs/pt-br.md
inputs:
- type: object
name: firewall_rule
label: Informe o CIDR/Porta da regra de firewall
inputs:
- type: text
name: cidr
label: CIDR
pattern: '^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}/\d{2}$'
- type: int
name: port
label: Porta
- type: int
name: host
label: Host
Solução
Publicar uma nova versão Major do plugin.yaml
ou da action.yaml
.
Problema: plugin/action '{slug}'
passou por mudanças significativas que podem afetar sua compatibilidade. Detalhes: "The new version needs to be a major version because, an input condition has been edited"
Esse erro acontece na publicação de conditions de Inputs nos seguintes cenários:
Confira o exemplo a seguir, aqui houve uma alteração do operador de condition de ==
para !=
:
- Arquivo
.yaml
em uma versão anterior:
spec:
type: python
docs:
pt-br: docs/pt-br.md
inputs:
- label: Qual versão do Java deseja usar?
type: text
name: java_version
items:
- test
- test
condition:
variable: language
operator: "=="
value: Java
- Arquivo
.yaml
em uma versão atualizada:
spec:
type: python
docs:
pt-br: docs/pt-br.md
inputs:
- label: Qual versão do Java deseja usar?
type: text
name: java_version
items:
- test
- test
condition:
variable: language
operator: "!="
value: Java
Solução
Publicar uma nova versão Major do plugin.yaml
ou da action.yaml
.
Problema: plugin/action '{slug}'
passou por mudanças significativas que podem afetar sua compatibilidade. Detalhes: "The new version needs to be a major version because the app_allowed field has been changed"
O erro acontece em cenários de mudança permissão de aplicação de Plugins de Infraestrutura em Aplicações
Confira o exemplo a seguir em que houve uma mudança de app allowed
de false
para true
:
- Arquivo
.yaml
em uma versão anterior:
spec:
type: infra
app-allowed: false
- Arquivo
.yaml
em uma versão atualizada:
spec:
type: infra
app-allowed: true
Solução
Publicar uma nova versão Major do plugin.yaml
.
Problema: plugin/action '{slug}'
passou por mudanças significativas que podem afetar sua compatibilidade. Detalhes: "The version published need be a major version, a input connection interface type has been edited"
Esse erro acontece em cenários de mudança do input do tipo required-connection.
Confira o exemplo a seguir em que o input da Connection Interface Type foi alterado de dns_conn
para eks_conn
- Arquivo
.yaml
em uma versão anterior:
spec:
type: python
docs:
pt-br: docs/pt-br.md
inputs:
- type: object
name: firewall_rule
label: Informe o CIDR/Porta da regra de firewall
connection-interface-type: dns_conn
- Arquivo
.yaml
em uma versão atualizada:
spec:
type: python
docs:
pt-br: docs/pt-br.md
inputs:
- type: object
name: firewall_rule
label: Informe o CIDR/Porta da regra de firewall
connection-interface-type: eks_conn
Solução
Publicar uma nova versão Major do plugin.yaml
ou da action.yaml
.