From f86a66a9b2348414c0c3e258e7d6a3bb28bca2e1 Mon Sep 17 00:00:00 2001 From: Vibhav Bobade Date: Fri, 13 Oct 2023 13:44:30 +0530 Subject: [PATCH] feat: add uffizzi usage docs Signed-off-by: Vibhav Bobade --- .../using-uffizzi.md | 32 +++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 docs/build-customize-contribute/using-uffizzi.md diff --git a/docs/build-customize-contribute/using-uffizzi.md b/docs/build-customize-contribute/using-uffizzi.md new file mode 100644 index 000000000..6dfb7a8ba --- /dev/null +++ b/docs/build-customize-contribute/using-uffizzi.md @@ -0,0 +1,32 @@ +--- +title: Using Uffizzi ephemeral environments +--- + +When a pull request is opened against the (harbor github repo)[https://github.com/goharbor/harbor], a github action workflow will trigger the creation of a [Uffizzi](https://www.uffizzi.com) ephemeral environment. This environment is a Kubernetes cluster where harbor will be deployed built from the changes in the pull request. + +The ingress to the frontend for harbor will also be available in a comment posted by the github action. To log into the instance of harbor use the following credentials :- + +``` +username: admin +password: Harbor12345 +``` + +To access the kubernetes cluster you will have to log into Uffizzi from the CLI. For this you will have to install the `uffizzi` cli tool which can be installed from [here](https://docs.uffizzi.com/install/). + +Once you have installed the CLI follow the steps below to access the ephemeral kubernetes cluster for your PR. + +1. Login to Uffizzi, then select the `harbor` account and project: +``` +uffizzi login +``` + +``` +Select an account: + ‣ ${{ github.event.repository.name }} + jdoe + +Select a project or create a new project: + ‣ ${{ github.event.repository.name }}-6783521 +``` +2. Update your kubeconfig: `uffizzi cluster update-kubeconfig pr- --kubeconfig=[PATH_TO_KUBECONFIG]` +After updating your kubeconfig, you can manage your cluster with `kubectl`, `kustomize`, `helm`, and other tools that use kubeconfig files: `kubectl get namespace --kubeconfig [PATH_TO_KUBECONFIG]`