Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add uffizzi usage docs #501

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions docs/build-customize-contribute/uffizzi-virtual-clusters.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: Using Uffizzi virtual cluster ephemeral environments
---

When a pull request is opened against the [main goharbor/harbor GitHub repository](https://github.com/goharbor/harbor), a GitHub action workflow will trigger the creation of a [Uffizzi Virtual Cluster](https://www.uffizzi.com) ephemeral environment. This environment is a Kubernetes cluster where Harbor will be built and deployed 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-<pr-number> --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]`