Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jetbrains/teamcity-google-template
Google Cloud DM template to deploy TeamCity in GCP
https://github.com/jetbrains/teamcity-google-template
deployment-manager gcp google-cloud teamcity template
Last synced: 3 months ago
JSON representation
Google Cloud DM template to deploy TeamCity in GCP
- Host: GitHub
- URL: https://github.com/jetbrains/teamcity-google-template
- Owner: JetBrains
- License: apache-2.0
- Created: 2018-02-28T16:21:23.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-02-07T18:27:27.000Z (11 months ago)
- Last Synced: 2024-04-13T12:07:00.049Z (9 months ago)
- Topics: deployment-manager, gcp, google-cloud, teamcity, template
- Language: Jinja
- Size: 74.2 KB
- Stars: 19
- Watchers: 20
- Forks: 30
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/JetBrains#jetbrains-on-github)
# TeamCity Google Cloud Deployment Manager template
**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](https://cloud.google.com/sdk/gcloud/) locally or in the [Google Cloud console](https://console.cloud.google.com/).
The template allows deploying a TeamCity [server](https://hub.docker.com/r/jetbrains/teamcity-server/) and [agent](https://hub.docker.com/r/jetbrains/teamcity-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.
## Pre-requisites
### Service account
Please use the [IAM console](https://console.cloud.google.com/iam-admin/iam/project) to ensure that the [Deployment Manager service account](https://cloud.google.com/deployment-manager/docs/access-control#access_control_for_deployment_manager) `[project_number]@cloudservices.gserviceaccount.com` has the `Project Owner` role.
To do it, use the following command:
```sh
> 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/owner
```
### Google Cloud APIs
Ensure that you have enabled the following Google Cloud APIs in your project:
* [Cloud Deployment Manager V2 API](https://console.cloud.google.com/apis/api/deploymentmanager.googleapis.com/overview)
* [Google Cloud Resource Manager API](https://console.cloud.google.com/apis/api/cloudresourcemanager.googleapis.com/overview)
* [Google Identity and Access Management (IAM) API](https://console.cloud.google.com/apis/api/iam.googleapis.com/overview)
* [Cloud SQL Administration API](https://console.developers.google.com/apis/api/sqladmin.googleapis.com/overview)
To do it, use the following command:
```sh
> gcloud services enable deploymentmanager.googleapis.com sqladmin.googleapis.com iam.googleapis.com \
cloudresourcemanager.googleapis.com runtimeconfig.googleapis.com compute.googleapis.com
```
### Flatcar Container Linux Image
The 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](https://docs.flatcar-linux.org/os/booting-on-google-compute-engine/#uploading-an-image).
## Deployment
### Quick Start
The easiest and **not secure** way to create test TeamCity deployment is to execute the following command:
```sh
> gcloud deployment-manager deployments create \
--template https://raw.githubusercontent.com/JetBrains/teamcity-google-template/master/teamcity.jinja \
--properties zone:
```
Where `` should be unique name for deployment, e.g. "teamcity" and `` is set to one of the [zones](https://cloud.google.com/compute/docs/regions-zones/). To list available zones execute the following command:
```sh
> gcloud compute zones list
```
**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.
### Secure Deployment
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](https://cloud.google.com/dns/docs/quickstart)). Then proceed with the following steps:
1. Create [external IP](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-external-ip-address) and configure `A` record for your domain pointing to that IP. Wait until `nslookup ` 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.
2. Create a new TeamCity deployment:
```sh
> gcloud deployment-manager deployments create \
--template https://raw.githubusercontent.com/JetBrains/teamcity-google-template/master/teamcity.jinja \
--properties zone:,ipAddress:,domainName:,domainOwnerEmail:
```
Where `` should be unique name for deployment, e.g. "teamcity", `` is set to one of the [zones](https://cloud.google.com/compute/docs/regions-zones/), `` is set to the external IP address, `` is set to your domain name and optional `` 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](https://github.com/JrCs/docker-letsencrypt-nginx-proxy-companion) from the [Let's Encrypt](https://letsencrypt.org/) and [nginx reverse proxy](https://github.com/jwilder/nginx-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.
### Configuration Properties
It is possible to specify the following list of comma-separated `--properties` list for your deployment:
* `zone` - the [zone](https://cloud.google.com/compute/docs/regions-zones/) in which this deployment will run.
* `version` - the [TeamCity version](https://www.jetbrains.com/teamcity/download/) 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](https://cloud.google.com/compute/docs/instances/create-ptr-record#domain_ownership) 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](https://cloud.google.com/compute/docs/regions-zones/) 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.
#### Installation Size
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](https://cloud.google.com/compute/pricing#custommachinetypepricing) and [MySQL database](https://cloud.google.com/sql/docs/mysql/pricing).
## TeamCity Update
To change the TeamCity version, start the deployment script with the required version number and then execute the [Reset](https://cloud.google.com/compute/docs/instances/restarting-an-instance) action on the TeamCity GCE instance:
```sh
> gcloud deployment-manager deployments update teamcity \
--template https://raw.githubusercontent.com/JetBrains/teamcity-google-template/master/teamcity.jinja \
--properties zone:,version:
```
**Note**: The `zone` parameter cannot be changed during the deployment update.
## Under the Hood
During deployment, the template allocates the following resource:
* Service account with `Project Viewer`, `Cloud SQL Client`, `Compute Instance Admin`, `Storage Object Admin` and `Service Account Token Creator` roles.
* 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.
### GCE Instance
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 when `domainName` is set.
* `letsencrypt.service` - executes auto SSL certificate retrieval for specified `domainName`.
To diagnose problems you could use the following commands:
* `sudo systemctl (start|stop|status|restart) ` - to manage service operation state.
* `sudo journalctl -u ` - to view history of service log.
* `sudo journalctl -f -u ` - to execute tail view of service log.
### Installed Plugins
The template installs the following Google Cloud Platform integrations in TeamCity:
* [Google Cloud Agents](https://plugins.jetbrains.com/plugin/9704-google-cloud-agents) - allows scaling the pool of TeamCity build agents by leveraging GCE.
* [Google Artifacts Storage](https://plugins.jetbrains.com/plugin/9634-google-artifact-storage) - allows storing build artifacts in Google Storage Blobs.
## Common Problems
### "Subnetwork should be specified for custom subnetmode network" error while deployment
It happens when subnetwork was not specified or does not exist in the specified zone.
### Could not connect to the TeamCity server with custom network
Ensure that you have configured firewall rules to access TeamCity server on HTTP/HTTPS port.