Before creating a cloud account for GCloud/GCP on the Aviatrix controller, go through the steps below to make sure you have the credentials set up for API calls.
Step 1: Create a GCloud Account¶
Create a GCloud or GCP account (https://cloud.google.com/). Go on to the next step if you have already done so.
Note that the controller supports multiple accounts with each one associated with a different GCloud projects, but there needs to be at least one to start with.
Step 2: Create a GCloud Project¶
Login to your GCloud account and go to the project page: https://console.cloud.google.com/project
Create a project. Go on to the next step if you have already created one. Note the project ID will be used in referencing to the project by Aviatrix controller.
(As an example, we created a project Aviatrix-UCC, the project ID is aviatrix-ucc-1214)
Step 3: Enable Compute Engine API¶
Enable Compute Engine API on the selected project,
- Go to your Google Cloud Platform console, at the upper left corner left to Google Cloud Platform signage, click the 3 bars. A drop down menu will appear.
- Select APIs and Services, at Dashboard, click on Enable APIs and Services
- On the Search box, input Compute Engine API and select it from search result
- click Enable.
Step 4: Create Credential File¶
When you create a cloud account Aviatrix Controller for GCloud, you will be asked to upload a GCloud Project Credentials file. Below are the steps to download the credential file from the Google Developer Console.
Open the Credential page
Select the project you are creating credentials for.
At Credentials, Click Create credentials, select Service account, as shown below
At the Service Accounts, enter a Service account name and click Create. For Service account permissions, select Project, Editor, as shown below.
- Select a service account. Click the 3 skewer bar and select Create Key. Select JSON, click Create.
- Click Create. The credential file will be downloaded to your local computer.
- Upload the Project Credential file to the Aviatrix controller at the GCloud account create page.
Note: Creating Service Account with Restricted Access¶
It is recommended to create the service account with the Editor role as mentioned in Step 5.4 but in some cases an organization might want to further restrict permission for the service account. In such a situation Aviatrix recommendation is to have at least following roles assigned to service account so that Aviatrix can perform its functions properly. For instance managing the compute resources, route tables, firewall rules, shared service vpc network etc.
- Compute Admin
- Service Account User
- Organization Administrator (required for GCP Shared VPC)
- Project IAM Admin (required for GCP Shared VPC)
If an organization is currently using GCP Shared VPC or planning to use in future then it is a requirement to enable Organization Administrator and Project IAM Admin as well.
In addition to restricting the GCP roles, you can restrict the rights for those roles. You can grant roles permission to perform the following tasks:
compute.addresses.create compute.addresses.createInternal compute.addresses.delete compute.addresses.deleteInternal compute.addresses.get compute.addresses.list compute.addresses.use compute.addresses.useInternal compute.disks.create compute.disks.get compute.firewalls.create compute.firewalls.delete compute.firewalls.get compute.firewalls.list compute.firewalls.update compute.forwardingRules.create compute.forwardingRules.delete compute.forwardingRules.list compute.globalOperations.get compute.healthChecks.create compute.healthChecks.delete compute.healthChecks.useReadOnly compute.httpHealthChecks.get compute.httpHealthChecks.useReadOnly compute.images.list compute.images.useReadOnly compute.instanceGroups.create compute.instanceGroups.delete compute.instanceGroups.get compute.instanceGroups.update compute.instanceGroups.use compute.instances.create compute.instances.delete compute.instances.get compute.instances.list compute.instances.setMachineType compute.instances.setMetadata compute.instances.setTags compute.instances.start compute.instances.stop compute.instances.updateNetworkInterface compute.instances.use compute.networks.addPeering compute.networks.create compute.networks.delete compute.networks.get compute.networks.list compute.networks.removePeering compute.networks.updatePolicy compute.projects.get compute.projects.setCommonInstanceMetadata compute.regionBackendServices.create compute.regionBackendServices.delete compute.regionBackendServices.get compute.regionBackendServices.update compute.regionBackendServices.use compute.regionOperations.get compute.routes.create compute.routes.delete compute.routes.list compute.subnetworks.create compute.subnetworks.delete compute.subnetworks.get compute.subnetworks.list compute.subnetworks.use compute.subnetworks.useExternalIp compute.targetPools.addInstance compute.targetPools.create compute.targetPools.delete compute.targetPools.get compute.targetPools.removeInstance compute.targetPools.use compute.zoneOperations.get compute.zones.list iam.serviceAccounts.actAs logging.logEntries.create pubsub.subscriptions.consume pubsub.subscriptions.create pubsub.subscriptions.delete pubsub.subscriptions.get pubsub.topics.attachSubscription pubsub.topics.create pubsub.topics.delete pubsub.topics.get pubsub.topics.publish resourcemanager.projects.get