Altostra Docs

    ›CI/CD

    Getting Started

    • Welcome to Altostra
    • Connect your accounts
    • Install the developer tools
    • Log in from the CLI

    Tutorials

    • Create a Static Website
    • Create a Scalable Webhook
    • Create a Simple API Project
    • Try Altostra without connecting cloud accounts
    • CI/CD with Altostra CLI and Github Actions

    How To

      Working with projects

      • Create a new project
      • Deploy a project
      • Manage a project

      Working with environments

      • Manage an environment
      • Configure instances expiration for an environment

      Working with the Editor

      • Grant access to vendor services
      • Use the Parameter Store
      • Use a custom CloudFormation resource
      • Attach a custom policy to a Function
      • Connect a Function to VPC
      • Add filter policy to SNS subscription

      Organization account settings

      • Set General Settings
      • Connect a Git account
      • Connect Cloud Accounts
      • Manage log aggregation accounts

    CLI

    • Altostra CLI
    • Commands

      • templates
      • new
      • init
      • push
      • deploy
      • sls-deploy
      • sync
      • invalidate
      • domains
      • console
      • environments
      • images
      • instances
      • build
      • config
      • import
      • projects
      • tasks
      • activity-log
      • login
      • logout
      • account
      • whoami
      • api-key
      • docs

      Options

      • --debug
      • --verbose
      • Scripting options
    • Configuration files

    Errors And Solutions

    • Autnentication Required

    Technical Reference

    • Environments
    • Playground Environment
    • Instances
    • Project image
    • Image Repository
    • Log Shipping
    • Deployment Modes
    • Altostra Cloud Integration

    Integrations

      CI/CD

      • CircleCI

      Git

      • Git integration
      • Connect a GitHub account
      • Connect a Bitbucket account

    CircleCI

    Orb Quick Start Guide

    The Altostra Orb is used to simplify the integration of Altostra into your CircleCI pipeline, and to help you streamline your CI/CD process.

    1. Use CircleCI version 2.1 at the top of your .circleci/config.yml file.
    version: 2.1
    
    1. Add the orbs step below your version to include the orb:
    orbs:
      altostra-orb: altostra/altostra-orb@x.y
    
    1. In order to use the Altostra Orb, you will need to set your Altostra API token in the ALTO_API_KEY environment variable of the project.

    Commands

    The orb contains these commands:

    setup

    altostra-orb/setup - Installs the latest Altostra CLI and sets up your API token from the ALTO_API_KEY environment variable

    push

    Push a new image of the current project

    PARAMETERDESCRIPTIONREQUIREDDEFAULTTYPE
    image-nameThe image name (i.e: 1.0.0, v2.4.1, alpha, dev, test, ...)[x]-string

    deploy-version

    Deploy the current project from an existing image

    PARAMETERDESCRIPTIONREQUIREDDEFAULTTYPE
    image-nameThe image name (i.e: 1.0.0, v2.4.1, alpha, dev, test, ...)[x]-string
    instance-nameThe instance name to deploy[x]-string
    env-nameThe environment to which to deploy[x]-string

    deploy

    Push and deploy the current project

    PARAMETERDESCRIPTIONREQUIREDDEFAULTTYPE
    image-nameThe image name (i.e: 1.0.0, v2.4.1, alpha, dev, test, ...)''string
    instance-nameThe instance name to deploy[x]-string
    env-nameThe environment to which to deploy[x]-string

    Usage Examples

    Deploying a basic node project using orb commands

    version: 2.1
    
      orbs:
        altostra-orb: altostra/altostra-orb@x.y
    
      jobs:
        build-and-push:
    
          docker:
            - image: cimg/node:12.19
    
          working_directory: ~/repo
          steps:
            - checkout
            - altostra-orb/setup #Make sure you have the Environment Variable "ALTO_API_KEY" set in your project
            - install:
                name: Install node modules
                command: |
                  npm install
            - altostra-orb/deploy:
                instance-name: "MyInstance"
                env-name: "Development"
    
      workflows:
        alto-deploy:
          jobs:
            - build-and-push
    

    Jobs

    The orb contains these jobs:

    deploy-node-project

    PARAMETERDESCRIPTIONREQUIREDDEFAULTTYPE
    image-nameThe image name (i.e: 1.0.0, v2.4.1, alpha, dev, test, ...)''string
    instance-nameThe instance name to deploy[x]-string
    env-nameThe environment to which to deploy[x]-string
    node-versionPick a specific circleci/node image variant: https://hub.docker.com/r/cimg/node/tags[]'12.19'string

    Usage Examples

    Using the deploy-node-project job

    version: 2.1
    orbs:
      altostra-orb: altostra/altostra-orb@x.y
    
    workflows:
      use-altostra-job:
        jobs:
          - altostra-orb/deploy-node-project:
              node-version: '12.17'
              instance-name: "test-job"
              env-name: "Daylong"
    
    ← Altostra Cloud IntegrationGit integration →
    • Orb Quick Start Guide
      • Commands
      • Usage Examples
      • Jobs
      • Usage Examples

    Ready to Get Started?

    Get Started for Free
    © 2021 Altostra, Inc.