🏃Quickstart

Getting started with Resourcely

Resourcely is a configuration platform for defining and deploying cloud infrastructure that meets your expectations, at scale.

Setting up Resourcely

If you want to use Blueprints or Guardrails before setting up Resourcely, skip to First Blueprint or First Guardrail. We have pre-loaded Blueprints and Guardrails that you can experiment with.

Log in to Resourcely

Make sure you are logged in to Resourcely at https://portal.resourcely.io.

Fork our scaffolding repo

If you have an existing Terraform runner (for example, integrated into your company's CI pipeline) or are using GitLab, find your existing scenario and following the Advanced Setup. Otherwise, follow the instructions below to set up a free Terraform runner using GitHub Actions.

Fork this repo into your own GitHub account. This repo does the following:

  1. Creates a basic Terraform structure with dummy AWS and GCP credentials

  2. Creates Resourcely.yaml for you, which defines your Resourcely config roots

  3. Sets up a GitHub Action that serves as your basic CI pipeline that will:

    1. Plan and apply Terraform

    2. Scan the plan results with Resourcely Guardrails

Add your Resourcely API token to your repo

Navigate to https://portal.resourcely.io/settings/generate-api-token.

  1. Under Role, select CI Runner. Under Expiration, select No Expiry

  2. Click Generate token and copy it

  3. Navigate to your newly forked GitHub repo

  4. Navigate to Settings -> Secrets and variables -> Actions

  5. Add a new repository secret named RESOURCELY_API_TOKEN with your copied API token as the secret value

Connect Resourcely to your GitHub account

Navigate to https://portal.resourcely.io/settings/change-management to give Resourcely access to pull request updates within GitHub.

  1. Click Connect to GitHub and select your GitHub account

  2. Choose "Only select repositories" and choose the forked scaffolding repository you created earlier

  3. Click Install & Authorize

  4. Click Add repository, select the forked scaffolding repository, and hit Save

Nice work! You are ready to start customizing Blueprints and Guardrails, and creating cloud resources that meet your standards. Get started with Blueprints or Guardrails below 👇

First BlueprintFirst Guardrail

PreviousOverviewNextFirst Blueprint

Last updated