Importing a Stack

You've written your stack file, now it's time to import it on Cycle.

It is recommended to commit your cycle.json file to the root of your git repo, and import directly from there. You can also, for speed or to test your stack file, import it by pasting it in directly. We'll cover both options.

Importing From A Git Repo

Once you've pushed up the cycle.json to a repo, navigate to the stack import form in the portal:

  1. Click Stacks in the nav menu on the left hand side.
  2. In the top right corner, click the blue Import Stack button.
  3. Select the Import from a Git Repo tile on the left, then click Next.

Stack Name

The stack name is for your reference, but it is recommended to name it after the application it builds.

Git Repo URL

Enter the URL to the git repo containing your stack file. If it starts with ssh://, you will need to enter the private SSH key associated with your repo.

The SSH Key should be an RSA PEM-encoded key

The process for associating your repo with an SSH key is different for each service. So whether you're using a service like GitHub, GitLab, or Bitbucket you'll want to reference your services documentation on the best practice. Generating the key itself is straightforward. This command will create an RSA PEM encoded key pair.
ssh-keygen -t rsa -b 4096 -m pem -f my-key-pair.pem

Importing A Raw Stack File

For convenience and testing purposes, you can paste your cycle.json file directly into the portal to test your build.

  1. Click Stacks in the nav menu on the left hand side.
  2. In the top right corner, click the blue Import Stack button.
  3. Select the Import from a File tile on the right, then click Next.

Stack Name

The stack name is for your reference, but it is recommended to name it after the application it builds.

Raw Cycle JSON File

This is where you paste your file. When you're ready, click Import. If there are any issues with your stack, the field will turn red and the error listed below.

Start the Import Job

Once your information is filled out, click Import. You'll be taken to a screen where you can see the progress of the import job. Depending on the amount of images that need to be imported, this could take awhile.

Importing the stack will also trigger an initial build. Later on, you can trigger additional builds manually, or via webhook, as you make changes to your stack.

Need Help?

If you've got questions about the platform or need some help getting started, our team is more than happy to assist. Whether you're new to containers or just new to Cycle, reach out to us via livechat by clicking the blue circle in the bottom right corner. Join our Slack channel, and get help from the dev team or other members of the community, and check out our Roadmap to see what's planned for the future!