Getting Started
Step 4 - Deploying to the Edge
In this guide we'll show you how to deploy your gateway to the edge, at over 200 data-centers around the world. The act of deployment creates new environments and it's worth familiarizing yourself with how environments work.
In this tutorial we'll show the default workflow via GitHub, but note that we also support GitLab, BitBucket (enterprise plan only) and custom CI/CD.
To follow this tutorial you'll need
- a GitHub account (it's free, sign up at github.com).
- a zuplo project - complete Step 1, Step 2 and Step 3 for a great start!
- to install the Zuplo GitHub deployer to GitHub - you can do that here
import "./partials/github-setup.md"
3/ Deploy another environment#
Zuplo makes it easy for teams to collaborate by allowing teams to create many preview environments. To create a new environment, simple go to your repo in GitHub and create a new branch.
Let's create a branch called development
Wait about 20s and head back to Zuplo - you should see a new entry in the
environment dropdown called development
.
4/ Push a change to 'development'#
Let's make a simple change to our working-copy
environment. Let's do something
simple like capitalize the Summary field from 'Get all todos' to 'Get All
Todos'. It doesn't really matter what the change is.
Save your changes. Click the GitHub button at bottom left and choose Commit & Push. Enter a description of your change in the dialog that pops up:
Click Commit & Push will create a new temporary branch in GitHub with a name
zup-...
. On the next dialog, click Create Pull Request.
This will navigate you to the screen in GitHub that allows you to create a Pull
Request. Change the base branch to development
(since that is the
environment we want to update first). Click Create pull request.
When ready, click Merge pull request
Once merged, you'll want to delete that temporary branch.
The successful merge will trigger a rebuild and deployment of development
with
your change. You can check this by choosing the environment development
in
Zuplo and navigating to the readonly Route Designer.
This shows how you can use widely recognized GitOps practices to manage how code flows through your environments using Pull Requests and protected branches.
Troubleshooting#
I don't see my repository listed in Zuplo project settings.
- Make sure you've granted access to the project with the Zuplo GitHub App, you can check that configuration here
I've connected my Zuplo project to a GitHub repository but get access errors when running commits, pulls or try to open a pull request.
- If you are the owner of the project, make sure you've granted access to the project with the Zuplo GitHub App, you can check that configuration here
- If this Zuplo project was shared with you, make sure you are a GitHub collaborator. This can be verified by going to the GitHub repository > Settings > Collaborators section. You'll need admin permissions to the repository.
- If the GitHub repository has been renamed or moved to a different organization, try disconnecting and reconnecting to it. You can do this by going to your Zuplo project's settings > Source Control section