This quickstart guides you through how to create your first managed control plane in Upbound. Connect Upbound to GCP, and use your control plane to create and manage PostgreSQL databases.
- An Upbound account.
- A GCP account with permissions to manage IAM policies.
- A GitHub account with permission to install GitHub Apps.
The first time you sign in to Upbound, you walk through a Getting Started experience designed to bootstrap your environment in the matter of minutes.
Go to Upbound to get started.
Create an organization
Your first time in Upbound you must create an organization. Give your organization an ID and a friendly name.
Select Create Organization.
On the next screen, start your free trial. This trial allows you to create up to three managed control planes, three configurations, and invite a total of 10 team members in an organization.
Choose a configuration
Upbound offers a curated gallery of Crossplane configurations for you to choose from. These configurations provide ready-built APIs that Upbound installs in your control plane. You can select the source link to view the configuration files that define this API in GitHub.
Select the Configuration called CloudSQL as a service.
Connect to GitHub
After you’ve selected a Configuration, you need to connect Upbound to your GitHub account. Upbound uses GitHub’s authorization flow and installs a GitHub app into your account.
Select Connect to GitHub.
After you’ve connected to GitHub, select an account owner and repository name. Upbound creates a new repository under your account and clones the contents of the Configuration into that repository.
Give your repository a name, like my-control-plane-apis.
Select Clone configuration to GitHub.
Create a managed control plane
After Upbound clones the Configuration into your own repository, create a managed control plane.
Give your control plane a name, like my-control-plane.
Select Create Control Plane.
Connect to GCP with OIDC
While Upbound creates your control plane, connect Upbound to GCP.
Upbound recommends using OpenID Connect (OIDC) to authenticate to GCP without exchanging any private information.
GCP doesn’t authenticate a second OIDC pool in the same projected connecting to Upbound.
Add a new Service Account to the existing pool instead.
Create an identity pool
- Open the GCP IAM Admin console.
- Select Workload Identity Federation.
- If this is your first Workload Identity Federation configuration select Get Started
- At the top of the page, select Create Pool.
- Name the pool, like upbound-oidc-pool.
- Enter a description like An identity provider for Upbound.
- Enable the pool.
- Select Continue
Add Upbound to the pool
Under the Add a provider to pool configuration under Select a provider use OpenID Connect (OIDC)
Provider Name: upbound-oidc-provider
Provider ID: upbound-oidc-provider-id
Issuer (URL): https://proidc.upbound.io
Select Allowed audiences
For Audience 1 enter sts.googleapis.com
Configure provider attributes
The provider attributes restrict which remote entities you allow access to your resources.
When Upbound authenticates to GCP it provides an OIDC subject (
sub) in the form:
Configure the google.subject attribute as assertion.sub
Under Attribute Conditions select Add Condition.
To authenticate any managed control plane in your organization, in the Conditional CEL input box put
Create a GCP Service Account
GCP requires Upbound to use a Service Account. The required GCP roles of the service account depend on the services managed by your control plane.
- Open the GCP IAM Admin console.
- Select Service Accounts.
- From the top of the page, select Create Service Account.
Service account details
Under Service account details enter
Service account name: upbound-service-account
Service account ID: upbound-service-account-id
Description: Upbound managed control planes service account
Select Create and Continue.
Grant this service account access to project
For the CloudSQL as a service configuration the service account requires the roles:
Cloud SQL Admin
Workload Identity User
Record the service account email address
At the list of service accounts copy the service account email.
Upbound requires this to authenticate your managed control plane.
Add the service account to the identity pool
Add the service account to the Workload Identity Federation pool to authenticate to Upbound with OIDC.
- Return to the Workload Identity Federation page and select the upbound-oidc-pool.
- Near the top of the page select Grant Access.
- Select the new service account, upbound-service-account.
- Under Select principals use All identities in the pool.Select Save.
In the Configure your application window, select Dismiss.
Enable the Cloud SQL Admin GCP API
GCP requires explicitly enabling the Cloud SQL Admin API.
Go to the Cloud SQL Admin API page in the GCP console.
Finish configuring the Upbound identity provider
Back in Upbound, finish configuring the identity provider.
In the Identifier of GCP project field enter your GCP project ID.
For the Name of federated identity provider, edit your GCP Project ID and enter:
In the Name of federated identity provider field.
In the Attached service account email address field enter the service account email.
Select Launch Control Plane.
Welcome to the Upbound Console
After completing the Get Started experience, you are in the Upbound Console and greeted by the Control Planes screen.
The control plane details view gives users a view into what’s happening on their control planes.
Create your first resource
From the control planes view, select the Portal tab, and select Open Control Plane Portal.
Select the PostgreSQLInstance resource.
Select the Create New button at the top-right of the page.
The form are the parameters defined in your custom API. Fill-in the form with the following:
- name: my-db
- namespace: default
- region: east
- size: small
- storage: 20
When you Create Instance the portal generates a Crossplane claim.
After creating an instance, the Events section are logs directly from Kubernetes.
Crossplane commonly generates a Kubernetes error
cannot apply composite resource: cannot patch object: Operation cannot be fulfilled that may appear as an Event.
You can ignore this error. For more information about what causes this, read Crossplane issue #2114.
Observe your resource
Navigate back to Upbound Console window and to your control plane in the Overview tab.
There’s now a claim card next to the
PostgreSQLInstance type card.
Select the claim and Upbound renders the full resource tree that’s getting created and managed by your managed control plane.
Congratulations, you created your first resources with your MCP.
To learn more about the core concepts of Upbound, read the concepts documentation. To learn how to begin building your own platform on Upbound, read the reference architecture knowledge base article.