Skip to main content

FAQ

In this section, you will find frequently asked questions and answers about StackSpot.

Concepts and Usage

Is StackSpot accessible?

The StackSpot teams are making our Design System (Citric) more inclusive and accessible. Some improvements have already been made, such as:

  • Components enhancement with appropriate contrast colors and optimizing the text for easier reading on devices.
  • StackSpot is compliant with WCAG guidelines at the AA level.

The teams will conduct tests to identify opportunities for improvement. We will soon launch two AAA themes: light mode and dark mode, focusing on contrast colors. These initiatives reinforce our commitment to providing an accessible and inclusive experience to everyone on the StackSpot platform.

What is Content? Is it developed by StackSpot itself?​

Content is any piece created using the StackSpot Engine framework.

  • Content can be Stacks, Starters, Plugins, Actions, and Links. It can be reused.

The developers create Content in the Studios. In the Workspace you can:

  • Use Content developed in the Studios.
  • Create Shared Applications and Infrastructures.

Check out more details:

What is a Workspace?

It's where the Content created in a Studio can be used. Workspace is a workplace where you can create Applications and Shared Infrastructure. It all depends on what you want and which context you need. Workspace is where you can set up a Cloud Provider.

Check more details in the About Workspaces section.

When I have access to an account, can I automatically see all of its Workspaces?

In the StackSpot Platform, yes. Once you're in an account, you can see all of its Workspaces. However, in order to use a Workspace, you must be part of a group associated with it.

On the other hand, in the STK CLI you can only view the Workspaces to which you are associated. See more details on the pages:

What can a Developer role do in a Workspace?

If the person is part of the Workspace, they will be able to:

  • Create Applications and Shared Infrastructure.
  • Define Stacks contexts.

If they are not in a Workspace, they can only view what is in it. Check more details:

How do I create and add members to a team?

To create teams you need to have management permissions. Check more details in the Roles and Permissions section.

For more information about creating teams, Check the Create Teams section.

Can I create Applications and Shared Infrastructures outside a Workspace?

No. To create and deploy an Application or Shared Infrastructure, you must be inside a Workspace. You also need to use the content (Plugins, Stacks, Starters, etc.) available in it.

When should I publish a new Plugin and/or Stack version?

Whenever you change something in the Stack or Plugin.

For more information, check out the pages:

What is a Starter?

It is a set of predefined Plugins of a Stack. You can apply them using the stk create app command. When you use a Starter, you can create an App and apply a Plugin package with one STK CLI command.

A Starter is useful for creators to define the most common Plugins combination in a Stack. This predefined package accelerates the process to create projects.

For more information, check How to create and add a Starter to a Stack.

Can Starters be versioned?

Yes, Starters are versioned according to Stack. To create a new version, you must create a new Stack version.

For more information, check How to create and add a Starter in Stack section.

What is a Context?

Contexts are sets of values used to define content settings in StackSpot. And they are divided into three levels:

  • Account
  • Workspace
  • Application

If you configure in the Account level, it overwrites values set in a Workspace. Then it overwrites values set in Applications. For example:

The input values you define in your Account level can be mandatory, or suggestions. After a value is set as mandatory, you cannot change within the Workspace or Application.

Check out all about Contexts in the Configure Contexts section.

How do I configure a Context in my Stack?

To set up a Context in your Stack, you must add it to your Workspace and define the inputs.

What does the stk-validate-app command validates?

The stk-validate-app command validates an Application structure. Execute this command inside the application’s folder. The command:

  • Validates the Application structure;
  • Removes empty folders;
  • Ignores files and folders that you do not want when you finish developing your application.

For more information, check the STK CLI Commands section.

How do I create and publish a Plugin?

Check out the steps to create and publish Plugins:

How can I check my logs?

The logs are on the .stk folder in your /user/.stk/logs user.

How can I apply a Plugin locally?

Execute the command:

stk apply plugin <local path>

On Windows:

stk apply plugin 'plugin-complete-path'

The STK CLI login happens only on the default browser?

Yes, the log in via STK CLI always redirects you to your default browser.

Can I check STK CLI error logs on the screen?

Yes, use: export HTTP_ENABLE_DEBUG=true

How to create a version for a Plugin in a Stack?

You need to be in a team in a Studio and have permission to edit.

Follow the instructions:

  1. On SKT CLI, execute the stk publish command with the new Plugin version. Add the right plugin.yaml version.

  2. Access the StackSpot Portal. Click on 'Studio > Stack';

  3. On your Stack, click on the 'New Version' button;

  4. On the left side menu, select the Plugin (app or infra);

  5. Click on the 'Add Plugin' button and select the new version;

  6. Publish your Stack.

How to add a new Plugin version in a Starter (versioning the Starter)?

You need to be in a team in a Studio and have permission to edit.

Follow the instructions:

  1. On SKT CLI, execute the stk publish command with the new Plugin version. Add the right plugin.yaml version.

  2. Access the StackSpot Portal. Click on 'Studio > Stack';On your Stack, click on the 'New Version' button;

  3. On the left side menu, select the Plugin (app or infra);

  4. Click on the 'Add Plugin' button and select the new version;

  5. Return to the Stack and select the Starter;

  6. Remove the Plugin with the previous version;

If the Starter has only one Plugin, it is deleted. In this case, you need to create a new Starter.

  1. Add the Plugin with the current version. Now, publish your Stack.

Service Catalog

When trying to upload an OpenAPI standard file, it does not appear for me to select. What’s the issue?

Check if the file has the .yaml, .yml, or .json extension.

When creating a Gateway API, it requests an URL. Where do I get this URL?

Contact the person responsible for your Organization. They can provide you with the Gateway URL.

I have created a Product, but it does not appear in the Catalog for my Partner

You created a product as a Draft, now you need to publish it in the Catalog for others to view.

I have created an API, but it does not appear in the Catalog for my Partner

You created an API as a Draft, now you need to publish it in the Catalog for others to view.

I can't view my API or Product in the Catalog, even after publishing it

You can check the Service Catalog by environment. So, when you access it you must select the environment in which the API or Product was published.

I have registered my Partners, but how will they be notified to access the Partner Portal?

The Partners receive an e-mail invitation to access the Portal. The partners will have to set a password and then log in.

I am trying to request access to an API, but I can’t select my consuming Application

You cannot request access to an API when there is already one in progress. Check the generated credentials in the API Credential menu.

**I have requested access to an API, how will I know that it worked?

When the client's administrator grant access, you will receive an email about it. Another way to follow up is to check if the credential was generated on the API screen, in the API Credential menu. If it doesn’t work, please contact the Administrator.

I received an e-mail telling me I have access to the API, but I still can't access it through my Application. What can I do?

In this case, contact your Administrator to check what happened.

Migration v4.5 to v1.0

I am a StackSpot customer, I already use the STK CLI. What changes for me in the new version (v1.0.0)?

STK CLI is still used, you just need to update to the new version. Now, you need to use Stackspot's Platform, to create and manage your organization's content.

  • Templates, Tasks, and Stackfiles no longer exist.
  • Stacks and Plugins have now a broader concept.
  • Besides Studios, there are also Workspaces to create Applications and Shared Infrastructures.

Check out more details in the Migrate 4.5 to v1.0 section.

I already have STK CLI from Stackspot v4.5. Do I need to reinstall to get the new version or just upgrade?

In Stackspot v4.5, STK CLI is in its v.0 version. To use Stackspot v.1, you must upgrade STK CLI to v.1. If you only execute the stk upgrade command, it will not work.

Follow the instructions in the Upgrade STK CLI section.

What content can I migrate from v4.5 to v1.0?

Currently, you can migrate Plugins and Templates to the new version. And since the Templates feature is gone, everything will be Plugins.

You won’t be able to migrate Stack, Stackfiles, Tasks, etc.

How to migrate my Plugins from v4.5 to v1.0?

Check out how to migrate Templates and Plugins.

Templates and Plugins content change to the new version.

You won’t be able to migrate Stack, Stackfiles, Tasks.

Check out more details in the Migrate 4.5 to v1.0 section.

Can I reuse my Studio from version 4.5?

No, you need to use the Studio available in the StackSpot Platform.

Can I use my Community access in the new version?

Login via 'Community' is not available yet in Stackspot's new version. You can still use the old version. Access StackSpot Legacy Website.

This website will be available for a temporary period.

I don't want to use the new version, because I still need to use Stacks and Plugins from the old version. What can I do?

You can access the StackSpot Legacy Website and use the STK CLI old version (stk-legacy). The legacy environment will be deprecated soon. StackSpot recommends you migrate your Templates and Plugins to the new version.

You won’t be able to migrate previous features like Stack, Stackfiles, or Tasks.

Can I still edit or use old Stacks?

The old Stacks are still on the GitHub repositories. You can continue using your Stacks, Templates, and Plugins with stk-legacy. It is available at StackSpot's Legacy Website.

If you migrate, you need to adapt the Stacks, turning them into Plugins. There are no Templates nor Stackfiles in the new version.

Is there a deadline for the old version to be deprecated?

There is no deadline yet. When it happens, you will receive an official warning.

Is it possible to publish Stacks with Community access in the previous version?

You can no longer change the Studio's or Stacks' visibility in the Community area. You can still create and test Studios and Stacks as Drafts. But you will not be able to make the content public.

Was this page helpful?