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.

Sign up for GitHub

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

[YUNIKORN-2676] Get started yunikorn with load-balancer #439

Closed
wants to merge 3 commits into from
Closed

[YUNIKORN-2676] Get started yunikorn with load-balancer #439

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a2e0825
[YUNIKORN-2676] Get started yunikorn with load-balancer
0yukali0 Jun 16, 2024
411f632
[YUNIKORN-2676] Get started yunikorn with load-balancer
0yukali0 Jun 16, 2024
8788c41
[YUNIKORN-2676] Get started yunikorn with load-balancer
0yukali0 Jun 16, 2024
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
8 changes: 8 additions & 0 deletions docs/developer_guide/env_setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,14 @@ Kind version 0.15 is required for Kubernetes 1.25 or later.
Later versions of Kind add Kubernetes 1.26, 1.27 and 1.28.
Check the Kind release notes for the specific Kubernetes releases supported.

### Load Balancer
Cloud provider KIND is a standalone binary which connect to the KIND cluster and provision new Load Balancer containers.
```shell script
go install sigs.k8s.io/cloud-provider-kind@latest
export PATH=$PATH:$(go env GOPATH)/bin
cloud-provider-kind
```

### Using Kind

To test a new version of Kubernetes, you can pull a corresponding image from
Expand Down
16 changes: 15 additions & 1 deletion docs/get_started/get_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,12 @@ under the License.

Before reading this guide, we assume you either have a Kubernetes cluster, or a local Kubernetes dev environment, e.g MiniKube.
It is also assumed that `kubectl` is on your path and properly configured.
:::info

Follow this [guide](developer_guide/env_setup.md) on how to setup a local Kubernetes cluster using docker-desktop.

:::

## Install

The easiest way to get started is to use our Helm Charts to deploy YuniKorn on an existing Kubernetes cluster.
Expand Down Expand Up @@ -74,10 +78,20 @@ kubectl port-forward svc/yunikorn-service 9889:9889 -n yunikorn
`9889` is the default port for web UI.
Once this is done, web UI will be available at: `http://localhost:9889`.

:::info

If a load Balacner, [Metallb](https://metallb.universe.tf/), [Cloud Provider KIND](https://kind.sigs.k8s.io/docs/user/loadbalancer/) and so on, is available, setting `LoadBalancer` service type or [Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) are able to expose yunikorn service.

:::

![UI Screenshots](./../assets/yk-ui-screenshots.gif)

YuniKorn UI provides a centralised view for cluster resource capacity, utilization, and all application info.

Besides, YuniKorn also exposes its scheduling metrics via Prometheus.

If you want to monitor the yunikorn core services by using Prometheus and Grafana, you can find our step-by-step tutorial [here](../user_guide/prometheus.md).
:::info

If you want to monitor the yunikorn core services by using Prometheus and Grafana, you can find our step-by-step tutorial [here](../user_guide/prometheus.md).

:::