126 lines
6.1 KiB
Markdown
126 lines
6.1 KiB
Markdown
---
|
|
title_tag: "Pulumi Cloud: CI/CD Integration Assistant"
|
|
meta_desc: The CI/CD integration assistant helps you integrate Pulumi into CI/CD systems for automatically deploying stacks. Learn more about the assistant here.
|
|
title: "CI/CD assistant"
|
|
h1: "CI/CD integration assistant"
|
|
meta_image: /images/docs/meta-images/docs-meta.png
|
|
menu:
|
|
pulumicloud:
|
|
parent: deployments
|
|
weight: 10000
|
|
aliases:
|
|
- /docs/intro/console/extensions/
|
|
- /docs/intro/console/extensions/ci-cd-integration-assistant/
|
|
- /docs/intro/console/ci-cd-integration-assistant/
|
|
- /docs/intro/pulumi-service/ci-cd-integration-assistant/
|
|
- /docs/intro/pulumi-cloud/ci-cd-integration-assistant/
|
|
---
|
|
|
|
{{% notes "info" %}}
|
|
The CI/CD integration assistant helps you integrate Pulumi into CI/CD systems for automatically deploying stacks and is only available
|
|
to [Organizations](/docs/pulumi-cloud/organizations/), not personal accounts.
|
|
{{% /notes %}}
|
|
|
|
<!--more-->
|
|
|
|
A version control system (VCS) provides team collaboration capabilities and ensures that the source code for your Pulumi project
|
|
is not on a single developer's machine.
|
|
Using a CI/CD system makes your team more productive, by automatically deploying your Pulumi stacks.
|
|
The assistant contains a guided experience to help teams configure a VCS as well as automate it with a CI/CD pipeline.
|
|
|
|
The assistant supports using the same service for both version control and CI/CD,
|
|
as well as using different services for version control and CI/CD.
|
|
|
|
|
|
|
|
## Using the CI/CD Assistant
|
|
|
|
1. Navigate to a stack in a Pulumi Cloud organization.
|
|
2. Select **Settings** in the top navigation.
|
|
3. Select **Integrations** in the left navigation.
|
|
4. Notice the CI/CD assistance at the top of the page. Note: If you do not see the assistant on this page, it means CI/CD is already setup for the stack.
|
|
|
|
## VCS Identity Options
|
|
|
|
{{% notes "info" %}}
|
|
If your identity isn't tied to a VCS service (for example, if you're using SAML or email), you will still be able to get a customized CI/CD
|
|
workflow for your stack.
|
|
{{% /notes %}}
|
|
|
|
VCS configuration applies to the Pulumi project in which your stack is created. Services such as Atlassian Bitbucket, GitHub, GitLab offer both a version control system as well as a CI/CD service.
|
|
|
|
* Bitbucket offers [Bitbucket Pipelines](https://support.atlassian.com/bitbucket-cloud/docs/get-started-with-bitbucket-pipelines/)
|
|
* GitHub has [GitHub Actions](https://github.com/features/actions)
|
|
* GitLab has [GitLab CI/CD](https://docs.gitlab.com/ce/ci/)
|
|
|
|
This might be a convenient option if your team wishes to keep everything related to your Pulumi project on a single service.
|
|
|
|
To configure VCS using the CI/CD Assistant:
|
|
|
|
1. Select a VCS identity, and CI/CD pipeline.
|
|
1. Navigate to the link provided by the assistant.
|
|
1. Create a new repository using your selected service.
|
|
1. Follow the VCS configuration instructions and check off the boxes as you complete each step.
|
|
1. After each step, select the **Next** button to move to the next step.
|
|
|
|
## Configure CI/CD secrets
|
|
|
|
Now that your Pulumi project is configured to use a VCS your team can collaborate with you easily.
|
|
Most importantly, your Pulumi project is safe from accidents on your local machine!
|
|
|
|
If you start the CI/CD integration assistant having configured the VCS for your project already,
|
|
the assistant will skip to the next step automatically. You can see the repository that your project
|
|
is integrated with by selecting the **Configure VCS** step marker.
|
|
|
|
The **Configure CI/CD** step will help you configure secrets that will be used by your Pulumi stack.
|
|
For supported services, the assistant will provide a convenient link to the respective location
|
|
where you can configure the secrets.
|
|
|
|
The assistant provides a convenient way to create a [Pulumi access token](/docs/pulumi-cloud/accounts#access-tokens)
|
|
without needing to leave the page.
|
|
|
|
|
|
|
|
In the following example the assistant is being used to configure a GitHub Actions workflow.
|
|
So the assistant provides a direct link to configure secrets for your workflow.
|
|
|
|
See the [Registry](/registry/) page to find the setup page for your cloud provider.
|
|
|
|
## Add the workflow
|
|
|
|
Once the secrets are configured, the next step gives you the relevant workflow to add to your repository.
|
|
The workflow is customized for the current stack, so you can be sure that you are configuring a workflow that uses
|
|
the correct stack configuration.
|
|
|
|
|
|
|
|
{{% notes "info" %}}
|
|
Be sure to commit the new workflow file to a separate branch and not directly to your primary branch. This will create a new pull request for you.
|
|
{{% /notes %}}
|
|
|
|
The workflow configuration provided by the assistant is configured to run a `pulumi preview` for pull request builds.
|
|
Pull request builds help you catch problems _before_ the changes are merged -- a very important consideration for infrastructure
|
|
that is likely hosting services critical to your business.
|
|
|
|
## Validation
|
|
|
|
In the previous step, you committed a new workflow configuration by creating a new pull request. This will trigger a new build
|
|
that will run the `pulumi preview` command. Select the **Next** button to validate the CI configuration.
|
|
|
|
Congratulations on configuring a version control system and an automated pipeline for your stack! 🎉
|
|
|
|
{{% notes "info" %}}
|
|
If your pull request build failed, use the [CI/CD troubleshooting guide](/docs/using-pulumi/continuous-delivery/troubleshooting-guide) to diagnose the issue.
|
|
{{% /notes %}}
|
|
|
|
## Skip the line and get the workflow directly
|
|
|
|
If you want to access the workflow for a specific CI/CD service and configure VCS on your own,
|
|
you can do that by selecting a service from the drop-down to get started. You will
|
|
still get a workflow template that is customized to your stack.
|
|
|
|
{{% notes "info" %}}
|
|
This option is more suitable for teams that want to use different services for their VCS repo and CI/CD needs. For example, you want
|
|
to be able to use Azure Pipelines with a GitHub repository and just want the workflow template for Azure Pipelines.
|
|
{{% /notes %}}
|