NOTE: This is for illustrative purposes only and is not intended to be used to create a production-ready deployment of TeamCity.
Allows creating a TeamCity deployment in Google Cloud by using the gcloud tool locally or in the Google Cloud console.
The template allows deploying a TeamCity server and agent in Google Cloud Platform. It creates a MySQL database, a Google Compute Engine (GCE) instance with Flatcar Container Linux and starts TeamCity in a Docker container.
Please use the IAM console to ensure that the Deployment Manager service account [project_number]@cloudservices.gserviceaccount.com has the Project Owner role.
To do it, use the following command:
> gcloud projects add-iam-policy-binding $(gcloud config get-value project) \
--member serviceAccount:$(gcloud projects describe $(gcloud config get-value project) \
--format="value(projectNumber)")@cloudservices.gserviceaccount.com --role roles/ownerEnsure that you have enabled the following Google Cloud APIs in your project:
- Cloud Deployment Manager V2 API
- Google Cloud Resource Manager API
- Google Identity and Access Management (IAM) API
- Cloud SQL Administration API
To do it, use the following command:
> gcloud services enable deploymentmanager.googleapis.com sqladmin.googleapis.com iam.googleapis.com \
cloudresourcemanager.googleapis.com runtimeconfig.googleapis.com compute.googleapis.comThe Flatcar Container Linux image is not published to Google Cloud, so in order to use it you will have to publish it to your project. Follow the official guide.
The easiest and not secure way to create test TeamCity deployment is to execute the following command:
> gcloud deployment-manager deployments create <deploymentName> \
--template https://raw.githubusercontent.com/JetBrains/teamcity-google-template/master/teamcity.jinja \
--properties zone:<zone>Where <deploymentName> should be unique name for deployment, e.g. "teamcity" and <zone> is set to one of the zones. To list available zones execute the following command:
> gcloud compute zones listNote: Deployment will take several minutes, on completion you will be able to navigate to the teamcityUrl output value to see the TeamCity web UI.
To create a production ready TeamCity deployment you need to have a domain name from any domain registrar and be able to configure A/CNAME records for this domain (if you don't have any you could use Google Cloud DNS). Then proceed with the following steps:
- Create external IP and configure
Arecord for your domain pointing to that IP. Wait untilnslookup <domainName>command on your computer will be resolved into target IP address. Note: it may take up to 48 hours, but normally takes up to 1 hour. - Create a new TeamCity deployment:
> gcloud deployment-manager deployments create <deploymentName> \
--template https://raw.githubusercontent.com/JetBrains/teamcity-google-template/master/teamcity.jinja \
--properties zone:<zone>,ipAddress:<ipAddress>,domainName:<domainName>,domainOwnerEmail:<domainOwnerEmail>Where <deploymentName> should be unique name for deployment, e.g. "teamcity", <zone> is set to one of the zones, <ipAddress> is set to the external IP address, <domainName> is set to your domain name and optional <domainOwnerEmail> is set to your e-mail to be notified in case of problems with SSL certificate retrieval.
During deployment will be created TeamCity server deployment with auto-retrieval of SSL certificates from the Let's Encrypt and nginx reverse proxy.
Note: Deployment will take several minutes, on completion you will be able to navigate to the teamcityUrl output value to see the TeamCity web UI.
It is possible to specify the following list of comma-separated --properties list for your deployment:
zone- the zone in which this deployment will run.version- the TeamCity version to be deployed. The properties are parsed as YAML values, so if you are specifying a major release version, put escaped single quotes around the value, e.g.\'2019.1\'.installationSize- the size of the installation: small/medium/large.serviceAccount- the e-mail of the service account specified for the TeamCity GCE instance.createStorageBucket- allows creating a storage bucket to store build artifacts.ipAddress- the preliminary created in the same region external IP address for TeamCity server.domainName- the verified domain name for TeamCity server which will be used to retrieve SSL certificate.domainOwnerEmail- the e-mail address of domain owner used to notify about SSL certificate renewal for domain name.network- the network name in the same region which will be used by the TeamCity GCE instance.subnetwork- the subnetwork name in the same region which will be used by the TeamCity GCE instance.
The list of pre-configured installation types:
| Installation Size | Typical Usage | vCPU | RAM | VM Data Disk | Database |
|---|---|---|---|---|---|
| small | 3 users, 100 builds/day | 1 | 3 GB | 30 GB HDD | db-n1-standard-1 |
| medium | 5 users, 300 builds/day | 2 | 4 GB | 50 GB SSD | db-n1-standard-1 |
| large | 20 users, 1000 builds/day | 4 | 8 GB | 100 GB SSD | db-n1-standard-2 |
Note: See pricing for Google Compute Engine and MySQL database.
To change the TeamCity version, start the deployment script with the required version number and then execute the Reset action on the TeamCity GCE instance:
> gcloud deployment-manager deployments update teamcity \
--template https://raw.githubusercontent.com/JetBrains/teamcity-google-template/master/teamcity.jinja \
--properties zone:<zone>,version:<version>Note: The zone parameter cannot be changed during the deployment update.
During deployment, the template allocates the following resource:
- Service account with
Project Viewer,Cloud SQL Client,Compute Instance Admin,Storage Object AdminandService Account Token Creatorroles. - Network, firewall rules, and static IP address.
- MySQL database and user.
- GCE instance with a data disk powered by Flatcar Container Linux and the assigned service account.
After deployment you will be able to connect to the GCE instance via SSH. In CoreOS TeamCity works as the following systemd service:
teamcity-server.service- launches TeamCity server.teamcity-agent.service- launches TeamCity agent.nginx.service- provides reverse proxy for TeamCity server whendomainNameis set.letsencrypt.service- executes auto SSL certificate retrieval for specifieddomainName.
To diagnose problems you could use the following commands:
sudo systemctl (start|stop|status|restart) <serviceName>- to manage service operation state.sudo journalctl -u <serviceName>- to view history of service log.sudo journalctl -f -u <serviceName>- to execute tail view of service log.
The template installs the following Google Cloud Platform integrations in TeamCity:
- Google Cloud Agents - allows scaling the pool of TeamCity build agents by leveraging GCE.
- Google Artifacts Storage - allows storing build artifacts in Google Storage Blobs.
It happens when subnetwork was not specified or does not exist in the specified zone.
Ensure that you have configured firewall rules to access TeamCity server on HTTP/HTTPS port.