Usage Engine Private Edition requires a license in order to be installed. If you do not have a license, then follow the instructions in the self service portal on how to retrieve a license. The Usage Engine Private Edition container images are hosted in the DigitalRoute AWS ECR registry, and in order to get access to them, DigitalRoute have provided you with the required access keys. If you, for one reason or another, have not received these access keys, then please contact the DigitalRoute technical support. The following general purpose tools are required to be installed locally: helm: To be able to install the required software in the Kubernetes cluster. kubectl: To interact with the Kubernetes cluster. terraform: This is used to configure the Kubernetes cluster. License
ECR Access Keys
General Purpose Tools
Installation instructions: https://helm.sh/docs/intro/install/
Installation instructions: https://kubernetes.io/docs/tasks/tools/#kubectl
Installation instructions: https://developer.hashicorp.com/terraform/install
This reference installation of Usage Engine Private Edition involves making it publicly available on the internet. For this to work, a public hosted zone is required to be set up prior the installation. This is your parent domain that will be used for subdomain creation later to allow Usage Engine Private Edition access through hostname. If you do not want to make Usage Engine Private Edition publicly available on the internet, this is not a requirement. Be aware that, in this case, URL(s) used to explain how to access certain resources later on in this installation guide, such as Desktop Online, may not work.Domain DNS Setup
GCP Specific Tools
The following GCP specific tool is required to be installed locally:
Google Cloud CLI. The GCP command line interface.
Installation instructions: https://cloud.google.com/sdk/docs/install-sdk
For details on compatible versions, please refer to the https://infozone.atlassian.net/wiki/x/owDKCg .
Minimum IAM User Policy
To use the installation guide, you need to ensure the user who performs the installation was granted with minimum permission in order to be able to provision GCP resources.
You do not need to setup the following if the user that performs the installation was granted with Editor role.
For best practice it is preferably to set up a minimum IAM role for the user to perform the installation.
To manage GCP project access, please refer to GCP documentation for guidance https://cloud.google.com/iam/docs/granting-changing-revoking-access.
The following table contains the permissions required by the application.
Application | IAM Role Permission |
|---|---|
Terraform | title: UEPE Terraform Role description: Minimum permissions that required by terraform stage: GA includedPermissions: - cloudsql.instances.create - cloudsql.instances.delete - cloudsql.instances.get - cloudsql.instances.update - cloudsql.users.list - compute.globalAddresses.createInternal - compute.globalAddresses.deleteInternal - compute.globalAddresses.get - compute.instanceGroupManagers.get - compute.networks.create - compute.networks.delete - compute.networks.get - compute.networks.removePeering - compute.networks.updatePolicy - compute.networks.use - compute.routers.create - compute.routers.delete - compute.routers.get - compute.routers.update - compute.subnetworks.create - compute.subnetworks.delete - compute.subnetworks.get - container.clusters.create - container.clusters.delete - container.clusters.get - container.clusters.update - container.operations.get - dns.changes.create - dns.changes.get - dns.changes.list - dns.managedZones.create - dns.managedZones.delete - dns.managedZones.get - dns.managedZones.getIamPolicy - dns.managedZones.list - dns.managedZones.update - dns.resourceRecordSets.create - dns.resourceRecordSets.delete - dns.resourceRecordSets.get - dns.resourceRecordSets.list - dns.resourceRecordSets.update - file.instances.create - file.instances.delete - file.instances.get - file.instances.update - file.operations.get - iam.roles.get - iam.serviceAccounts.create - iam.serviceAccounts.delete - iam.serviceAccounts.get - iam.serviceAccounts.getIamPolicy - iam.serviceAccounts.setIamPolicy - resourcemanager.projects.get - resourcemanager.projects.getIamPolicy - resourcemanager.projects.setIamPolicy - servicenetworking.services.addPeering - servicenetworking.services.get |
Kubectl | Grant role |