Differences

This shows you the differences between two versions of the page.

--- techsupport:kubernetes [2022/04/19 19:20] – kjohns23
+++ techsupport:kubernetes [2022/11/18 17:30] (current) – kjohns23
@@ Line 35: / Line 35: @@
 Integrate your Gitlab project with the Kubernetes cluster to automatically deploy and update your project. This Guide assumes you already have a project located in the SoCS Gitlab server, and that you have built the project into a Docker container.
-. You will need to host your Docker container. If the container can be publicly accessible, this can be hosted in Docker Hub. If it must be private, the SoCS Gitlab installation has it's own Docker Container Registry.
+. You will need to host your Docker container. If the container can be publicly accessible, this can be hosted in Docker Hub. If it must be private, the SoCS Gitlab installation has it's own Docker Container Registry. To access the SoCS Registry, use ''%% docker login registry.uoguelph.ca %%'' and enter your central login/Gitlab credentials. Directions to tag and push can be found in your Gitlab project under Packages & Registries > Container Registry.
 NB: In the future building a Docker container and pushing to the SoCS registry could be done through the CI/CD pipeline, but this is not yet available.
-X. Create two namespaces One for your project, and the other for the gitlab agent. From the [[ https://kubefarm.socs.uoguelph.ca/c/local/projects-namespaces Projects and Namespaces Menu ]] choose Add Namespace. Enter a name, leaving the other settings at their defaults and choose Create. This step MUST be done through Rancher, otherwise you will not have permissions to access the namespace you create.
+. Create .gitlab/agents/agent-name/config.yaml in your Gitlab project, replacing agent-name with whatever you want to name your agent.
+  gitops:
+    manifest_projects:
+    - id: "Your Project ID"
+      paths:
+      - glob: '/manifests/*.{yaml,yml,json}'
+Replace "Your Project ID" with the ID number of your project. This is listed under the project name in the main project screen.
+. From the Infrastructure > Kubernetes Clusters Menu, choose Add Agent and select the agent named in the previous step. Make sure you save the token that is created.
+. In Kubernetes, create two namespaces One for your project, and the other for the gitlab agent. From the [[ https://kubefarm.socs.uoguelph.ca/c/local/projects-namespaces Projects and Namespaces Menu ]] choose Add Namespace. Enter a name, leaving the other settings at their defaults and choose Create. This step MUST be done through Rancher, otherwise you will not have permissions to access the namespace you create.
+. <code> kubectl create secret generic -n your-gitlab-agent-namespace gitlab-kubernetes-agent-token --from-literal=token='Your Token Here' </code>
+. Customize the yaml file below with the namespaces you've chosen. You should also ensure the version of the image matches the version gitlab is currently running.
+   TODO
+   Put
+   Yaml
+   Here
+. Add the newly created yaml file with kubectl apply -f filename.yml The agent should now be installed. Time to deploy your application.
+. The next two steps are only necessary if you are using the SoCS gitlab server for your container registry, or if you are storing your container in another private registry. In your Gitlab Repo go to Settings > Registry > Deploy Tokens. Enter a name, optionally a username, and check read_registry
+. Run the following command, replacing your credentials. <code>echo -n "{REGISTRY_USERNAME}:{REGISTRY_PASSWORD}" | base64</code>
+Replace BASE_64_BASIC_AUTH_CREDENTIALS with the output of the above command. Replace your registry username and password as well.
+  {
+       "auths": {
+           "registry.socs.uoguelph.ca":{
+               "username":"REGISTRY_USERNAME",
+               "password":"REGISTRY_PASSWORD",
+               "email":"REGISTRY_EMAIL",
+               "auth":"BASE_64_BASIC_AUTH_CREDENTIALS"
+       	   }
+       }
+   }
+Save that file and run <code>cat filename | base64</code> to generate another string. Replace BASE_64_ENCODED_DOCKER_FILE in the below file with that string. Remove any newlines to place the string on one line. Modify the namespace variable with your project namespace.
+   apiVersion: v1
+   kind: Secret
+   metadata:
+     name: registry-credentials
+     namespace: YOUR NAMESPACE
+   type: kubernetes.io/dockerconfigjson
+   data:
+     .dockerconfigjson: BASE_64_ENCODED_DOCKER_FILE
+Take this final file, and run <code>kubectl apply -f filename</code>
+TODO REPLACE WITH EASIER METHOD kubectl create secret docker-registry <name> --docker-server=DOCKER_REGISTRY_SERVER --docker-username=DOCKER_USER --docker-password=DOCKER_PASSWORD --docker-email=DOCKER_EMAIL
+The gitlab agent is now set up and can pull your container from the SoCS container registry.
+==== Deploying your Application ====
+Look at official documentation TODO add instructions on how to do this. TODO maybe add a sample repository.
+The yaml file should be placed in your project git repository.