Deploy YouTrack with Kubernetes

Preparatory work

1. To run commands, you need to activate the Google Cloud Shell. Click the Activate Cloud Shell icon in the application header of the Google Cloud Console.

2. Select or create a Google Cloud project. If you experience any troubles during this stage, please refer to the Google Cloud documentation.

   • Use the following command to create a project in Google Cloud:

     gcloud projects create PROJECT_ID

   • Use the following command to select an existing project:

     gcloud config set PROJECT_ID

3. Make sure that billing is enabled for your Cloud project. To learn how, please refer to the Google Cloud documentation.

4. Use the following command to enable the Artifact Registry and Google Kubernetes Engine API:

   gcloud services enable artifactregistry.googleapis.com container.googleapis.com

5. First, you will need to pull an image of the latest YouTrack version from the Docker YouTrack Repository using docker pull command:

   docker pull jetbrains/youtrack:<version>

   Replace <version> with the complete version number and build. For a complete list of release versions, check Docker Hub.

6. Run the docker images command to verify that the build was successful:

   docker images

   In the output you should see jetbrains/youtrack:{version} among your loaded images:

   REPOSITORY TAG IMAGE ID CREATED SIZE jetbrains/youtrack 2022.1.42540 82c55a0fdf90 2 days ago 719MB

Deploy the YouTrack Image to the Cluster

1. Create a Kubernetes cluster or select a cluster that was created previously.

2. Use the following command to verify that you are connected to your GKE cluster.

   gcloud container clusters get-credentials [cluster-name] --zone [zone]

3. Create a Kubernetes Deployment so you can run the YouTrack application on the cluster.

   kubectl create deployment youtrack-app --image=jetbrains/youtrack:{version}

4. Create a StorageClass configuration in a youtrack-storage-class.yaml file:

   apiVersion: v1 kind: StorageClass metadata: name: youtrack-storage-class provisioner: kubernetes.io/gce-pd parameters: type: pd-ssd

   Apply the configuration:

   kubectl apply -f youtrack-storage-class.yaml

5. Create persistent volume claim (PVC) configurations for the data, config, logs and backup directories:

   For example, use the following command to create the data PVC configuration file:

   nano pvc-data.yaml

   Then add this content to the file:

   —----- apiVersion: v1 kind: PersistentVolumeClaim metadata: name: youtrack-data-pv-claim namespace: default spec: accessModes: - ReadWriteOnce storageClassName: storage-class-1 resources: requests: storage: 1Gi

   Use the following command to apply the configuration:

   kubectl apply -f pvc-data.yaml

6. New PVs are generated based on the newly created PVCs. To verify their creation, check Storage > [select desired PVC] > Volume.

7. You need to attach the PV to the Deployment. To perform this step, navigate to Workloads > [select deployment] > YAML > Edit and insert the following:

   volumeMounts: - mountPath: /opt/youtrack/data name: [data volume name] - mountPath: /opt/youtrack/conf name: [conf volume name] - mountPath: /opt/youtrack/logs name: [logs volume name] - mountPath: /opt/youtrack/backups name: [backup volume name] … volumes: - name: [data volume name] persistentVolumeClaim: claimName: youtrack-data-pv-claim - name: [logs volume name] persistentVolumeClaim: claimName: youtrack-logs-pv-claim - name: [backups volume name] persistentVolumeClaim: claimName: youtrack-backups-pv-claim - name: [conf volume name] persistentVolumeClaim: claimName: youtrack-conf-pv-claim

You should now see corresponding volumes in the Pod specification in your Deployment.

Troubleshooting

If you encounter a CrashLoopBackOff error, the pod may be crashing because it starts up and exits immediately afterward, then Kubernetes restarts and the cycle continues. For more details please check the Pod Lifecycle documentation. A possible solution is to add a command like sleep to the volumeMounts section of the YAML file to keep the container alive.

If the error directory opt/youtrack/data is not writable:

1. Check if the directory exists.

2. Use the following command to set the permissions for the directory:

   chown -R 13001:13001 [directory name]

Exposing the Application

Due to the specific nature of the Google Cloud service, the set of IP addresses that correspond to the active set of Pods is dynamic. You can expose a group of Pods outside the Kubernetes cluster with Services. This feature groups Pods into one static IP address, which can be reached from any Pod inside the cluster. The static IP address also is assigned a DNS hostname, for example, youtrack-app.default.svc.cluster.local.

To get more details about the service run:

You should receive an output like this:

After that, you can open a new browser tab and navigate to the EXTERNAL-IP:PORT, where PORT is equal to the target-port that you defined in the kubectl expose command. There you will see a Setup Wizard that lets you continue installing the YouTrack application.