BYO GCP Account¶
Xi Frame provides the option to “Bring Your Own” (BYO) Google Cloud Platform (GCP) account. Common reasons you may want to go with the BYO option include:
- You wish to take advantage of your existing billing arrangements with GCP for convenience and/or pricing. For example, your organization may already have certain GCP consumption commitments or pre-payments – and you can use Xi Frame to consume those resources on your own GCP account.
- You would prefer to “own” your Xi Frame workloads and therefore have full administrative access.
We allow any new Xi Frame account to be created under a non-default BYO GCP account to leverage “Bring Your Own GCP Account” feature.
- Ensure that you are an “Owner” of the GCP project you that you wish to use to host Xi Frame workloads.
- Your GCP Account ID is the only piece of information required to integrate with the Xi Frame Platform, which can be found by going to the Dashboard of your GCP console.
Add Xi Frame BYO GCP Cloud Account Credentials¶
Navigate to your Google Cloud Platform console by going to https://console.cloud.google.com/
Locate and copy the Project ID found in your GCP console Dashboard.
In a separate tab, navigate to your Xi Frame platform account. You can configure a new cloud provider on either the Org or Customer entity level. For this example, we will be configuring the GCP Cloud Account on the Organization level. Click the ellipsis listed to the right of the Org and select “Edit.”
Navigate to the “Cloud Provider” tab and click “Add Cloud Account” in the upper right corner of the screen.
The “Add new cloud account” window will appear. Select “Google” as your cloud provider.
Paste the Project ID you copied earlier from your GCP Console into the “Project ID” field.
After entering your GCP Project ID, a new field will appear displaying a command. Copy the command to your clipboard.
Next, click the “Prepare the Account with GCP Cloud Shell” button. A new tab will open, taking you to your GCP console.
A prompt will appear asking for your permission to proceed. Click “Proceed.”
After the Cloud Shell has initialized, paste the deployment command into the command shell and press “Enter.” Once the command has completed successfully, you can close the tab.
Navigate back to your Xi Frame platform tab and click “Verify Cloud Account Setup” button. Once verified, a message will appear below the button informing you that the cloud account setup has been verified.
Complete the setup by entering a descriptive name for your GCP Cloud Account and selecting the desired regions for your Xi Frame workloads. You can select multiple regions if desired.
You have completed the BYO GCP setup. Your new GCP Cloud Account will appear as an available cloud provider when creating a new Xi Frame account.
What Resources are Created by Xi Frame under my GCP Project?¶
Xi Frame will immediately create multiple roles comprised of the minimum required permissions for Frame’s backend communication and orchestration. Xi Frame also enables Google’s Compute Engine and Cloud DNS APIs.
GCP Service Limits¶
By default, a newly created GCP account will impose certain service limits on available resources. Depending on the size of the Frame workload required, you will likely need to adjust the default limits imposed on the GCP account. If these limits are set to values that are lower than what is required by the Xi Frame platform, you can expect certain functions to either fail, or be substantially delayed. The requirements by Xi Frame for these service limits depends on the desired workload and required resources. The recommended service limit increases include the following:
The following steps may not be necessary for smaller production environments or trial accounts.
|Compute Engine||Frame recommends setting the GCP Compute Engine quota limit to 2.2x your expected max number of instances. The additional 20% will accommodate any additional resources such as Sandboxes, Utility servers, etc.|
|Persistent Disk||Typically, this resource does not need to be modified. If you have any concerns about capacity, we recommend 80 GiB per instance.|
|IP Addresses (regional and global)||Each region has a base IP limit for both static and in-use IP addresses. You will need at least 2 public IPs available per workload instance and one public IP per Sandbox/Utility Server VM.|
|VPCs||With GCP, only a single VPC is required (even for multiple regions).|
|GPU-backed Instances||We recommend increasing Compute Engine limits for GPU-backed instances to 2.2x your expected max number of instances. The additional 20% will accommodate any additional resources such as Sandboxes, Utility servers, etc.|
We have created all new Business Account types on Xi Frame and we hope you will take this opportunity to transition your information and Accounts over to our new platform.