nebari-dev / nebari-dev/nebari-docs

Pre-existing Kubernetes cluster documentation doesn't cover on-prem cluster

Open
#608 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

needs: triage 🚦
Dominant language
No language data
Stars
21
Forks
40
Avg merge
19h 50m
Merged PRs (30d)
6

Description

Context

I have an on-prem Kubernetes cluster at work that I am attempting to install Nebari into, but the docs for pre-existing Kubernetes cluster only covers AWS installation. I am looking for a step-by-step guide for how to take the bootstrapped nebari-config.yaml and edit it for a cluster that I have a .kubeconfig for.

For example, following the directions in the above referenced docs, I end up with this nebari-config.yaml:

provider: existing
namespace: dev
nebari_version: 2025.10.1
project_name: nebari-new
ci_cd:
  type: none
terraform_state:
  type: remote
security:
  keycloak:
    initial_root_password: 33pd3kzhd2o4yw3m1s3lryg63dqlf9nc
  authentication:
    type: password
theme:
  jupyterhub:
    hub_title: Nebari - nebari-new
    welcome: Welcome! Learn about Nebari's features and configurations in <a href="https://www.nebari.dev/docs/welcome">the
      documentation</a>. If you have any questions or feedback, reach the team on
      <a href="https://www.nebari.dev/docs/community#getting-support">Nebari's support
      forums</a>.
    hub_subtitle: Your open source data science platform, hosted
existing:
  kube_context:
  node_selectors:
    general:
      key: kubernetes.io/os
      value: linux
    user:
      key: kubernetes.io/os
      value: linux
    worker:
      key: kubernetes.io/os
      value: linux

Where in there do I plug in my existing cluster's .kubeconfig values in order to connect the Nebari CLI with the cluster?

Values for reference:

apiVersion: v1
clusters:
- cluster:
    insecure-skip-tls-verify: true
    server: https://***link to our cluster***
  name: vcluster
contexts:
- context:
    cluster: vcluster
    user: vcluster
  name: vcluster
current-context: vcluster
kind: Config
preferences: {}
users:
- name: vcluster
  user:
    token: ***token-value***
Value and/or benefit

Having documentation that lays this out clearly would be of great value to users who do not have access to one of the cloud providers.

Anything else?

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing documentation for pre-existing Kubernetes clusters and inspect how the Nebari CLI consumes nebari-config.yaml and a .kubeconfig. Document the required configuration for an on-premises cluster, including where the kubeconfig context or values belong. Done means a user without cloud-provider access can follow the guide from a bootstrapped configuration to a connected deployment.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.