Skip to main content

Configure Self-Hosted Gitspaces

Welcome to the Self-Hosted Gitspaces configuration guide! This document will walk you through the key steps to configure and set up Self-Hosted Gitspaces in your infrastructure.

Prerequisites​

You need to follow these prerequisites to get started with self-hosted Gitspaces:

PrerequisiteDescriptionDocumentation Guide
Enable Feature Flag in Harness AccountEnable the feature flag CDE_HYBRID_ENABLED in your Harness account. Contact Harness Support to enable this feature flag.Harness Support
Enable APIs in GCP ProjectYour GCP Project (where your have created your GCP VM Instance) should have the following APIs enabled: Docs
Service AccountYou must have a Service Account with the "Owner" permission in the same GCP Project where you have your GCP VM Instance.Docs
Service Account KeyYou must create and download a Service Account Key in the same GCP Project and service account, this key is usually in the form of a JSON or P12 file, which contains the credentials necessary for the service account to authenticate.Docs
Terraform/OpenTofuYou must have Terraform/OpenTofu installed on your machine with internet access (please ensure you have the SA key downloaded here)Docs
Domain Manager AccessYou must have access to the domain manager to delegate the domain or subdomain you use for self hosted Gitspaces.Docs

Get Started with Self-Hosted Gitspaces​

This is a quick guide to help you set up and launch your Self-Hosted Gitspaces. Follow the steps below:

1. Go Through the Architecture & Key Concepts​

Before you begin setup, it’s important to understand the underlying architecture and concepts of Self-Hosted Gitspaces.

πŸ”— Make sure to review the following documentation thoroughly:

2. Configure Gitspace Infrastructure via Harness UI​

Start by configuring your Gitspace infrastructure via the Harness UI. This allows you to input your infrastructure details like Project ID, regions, etc., which will be referenced later during provisioning.

πŸ”— Configure Gitspace Infrastructure via Harness UI

3. Configure and Set Up the Terraform Module​

Once the infrastructure is configured in the UI, proceed to initialize and use the Harness Gitspaces Terraform Module. This module will create all required infrastructure and will set up VM instances for the CDE Gateway.

πŸ”— Set Up Terraform Module

4. Set Up Runner and Install Delegate​

After provisioning, install the Runner and Delegate on your VM Instance. This ensures the Harness Control Plane can communicate with your infrastructure to create and manage Gitspaces.

πŸ”— Set Up Runner and Install Delegate

5. Create Machines & Gitspaces​

Once the setup is complete, you can begin by creating machines and Gitspaces directly.

πŸ”— Create and Manage Machines