-

Nebari CLI

+

Nebari CLI

-

nebari

+

nebari

Nebari CLI 🪴

nebari [OPTIONS] COMMAND [ARGS]...
@@ -42,13 +43,13 @@

nebariOptions

--V, --version
+-V, --version

Nebari version number

---import-plugin <plugins>
+--import-plugin <plugins>

Import nebari plugin

Default:
@@ -58,7 +59,7 @@

nebari
---exclude-stage <excluded_stages>
+--exclude-stage <excluded_stages>

Exclude nebari stage(s) by name or regex

Default:
@@ -68,7 +69,7 @@

nebari
---exclude-default-stages
+--exclude-default-stages

Exclude default nebari included stages

Default:
@@ -78,7 +79,7 @@

nebari

-

deploy

+

deploy

Deploy the Nebari cluster from your [purple]nebari-config.yaml[/purple] file.

nebari deploy [OPTIONS]
@@ -86,35 +87,30 @@

deployOptions

--c, --config <config_filename>
+-c, --config <config_filename>

Required nebari configuration yaml file path

--o, --output <output_directory>
+-o, --output <output_directory>

output directory

Default:
-

./

+

'./'

---dns-provider <dns_provider>
+--dns-provider <dns_provider>

dns provider to use for registering domain name mapping ⚠️ moved to dns.provider in nebari-config.yaml

-
-
Default:
-

False

-
-
---dns-auto-provision
+--dns-auto-provision

Attempt to automatically provision DNS, currently only available for cloudflare ⚠️ moved to dns.auto_provision in nebari-config.yaml

Default:
@@ -125,7 +121,7 @@

deploy
---disable-prompt
+--disable-prompt

Disable human intervention

Default:
@@ -136,7 +132,7 @@

deploy
---disable-render
+--disable-render

Disable auto-rendering in deploy stage

Default:
@@ -147,7 +143,7 @@

deploy
---disable-checks
+--disable-checks

Disable the checks performed after each stage

Default:
@@ -158,7 +154,7 @@

deploy
---skip-remote-state-provision
+--skip-remote-state-provision

Skip terraform state deployment which is often required in CI once the terraform remote state bootstrapping phase is complete

Default:
@@ -169,7 +165,7 @@

deploy -

destroy

+

destroy

Destroy the Nebari cluster from your [purple]nebari-config.yaml[/purple] file.

nebari destroy [OPTIONS]
@@ -177,24 +173,24 @@

destroyOptions

--c, --config <config_filename>
+-c, --config <config_filename>

Required nebari configuration file path

--o, --output <output_directory>
+-o, --output <output_directory>

output directory

Default:
-

./

+

'./'

---disable-render
+--disable-render

Disable auto-rendering before destroy

Default:
@@ -205,7 +201,7 @@

destroy
---disable-prompt
+--disable-prompt

Destroy entire Nebari cluster without confirmation request. Suggested for CI use.

Default:
@@ -216,13 +212,13 @@

destroy -

dev

+

dev

Development tools and advanced features.

nebari dev [OPTIONS] COMMAND [ARGS]...
-

keycloak-api

+

keycloak-api

Interact with the Keycloak REST API directly.

This is an advanced tool which can have potentially destructive consequences. Please use this at your own risk.

@@ -232,26 +228,26 @@

keycloak-apiOptions

--c, --config <config_filename>
+-c, --config <config_filename>

Required nebari configuration file path

--r, --request <request>
+-r, --request <request>

Required Send a REST API request, valid requests follow patterns found here: [green]keycloak.org/docs-api/15.0/rest-api[/green]

-

info

+

info

nebari info [OPTIONS]
-

init

+

init

Create and initialize your [purple]nebari-config.yaml[/purple] file.

This command will create and initialize your [purple]nebari-config.yaml[/purple] :sparkles:

This file contains all your Nebari cluster configuration details and, @@ -261,13 +257,13 @@

init
nebari init [OPTIONS] [CLOUD_PROVIDER]:[local|existing|do|aws|gcp|azure]
+
nebari init [OPTIONS] [CLOUD_PROVIDER]:[local|existing|aws|gcp|azure]
 

 

 
Options

 

 

---guided-init, --no-guided-init

+--guided-init, --no-guided-init
 
[bold green]START HERE[/bold green] - this will guide you step-by-step to generate your [purple]nebari-config.yaml[/purple]. It is an [i]alternative[/i] to passing the options listed below.

 

 
Default:

@@ -278,42 +274,48 @@ 
init
 

--p, --project-name, --project <project_name>

+-p, --project-name, --project <project_name>
 
Required

 

 
 

 

--d, --domain-name, --domain <domain_name>

+-d, --domain-name, --domain <domain_name>
 

 
 

 

---namespace <namespace>

+--namespace <namespace>
 

 
Default:

-
dev

+
'dev'

 

 

 

 
+

+

+--region <region>

+
The region you want to deploy your Nebari cluster to (if deploying to the cloud)

+

+
 

 

---auth-provider <auth_provider>

-
options: [‘password’, ‘GitHub’, ‘Auth0’, ‘custom’]

+--auth-provider <auth_provider>
+
options: [‘password’, ‘GitHub’, ‘Auth0’]

 

 
Default:

-
AuthenticationEnum.password

+
<AuthenticationEnum.password: 'password'>

 

 
Options:

-
password | GitHub | Auth0 | custom

+
password | GitHub | Auth0

 

 

 

 
 

 

---auth-auto-provision, --no-auth-auto-provision

+--auth-auto-provision, --no-auth-auto-provision
 

 
Default:

 
False

@@ -323,19 +325,15 @@ 
init
 

---repository <repository>

-
options: [‘github.com’, ‘gitlab.com’]

-

-
Options:

-
github.com | gitlab.com

-

-

+--repository <repository>
+
Github repository URL to be initialized with –repository-auto-provision

 

 
 

 

---repository-auto-provision, --no-repository-auto-provision

-

+--repository-auto-provision, --no-repository-auto-provision
+
Initialize the GitHub repository provided by –repository (GitHub credentials required)

+

 
Default:

 
False

 

@@ -344,11 +342,11 @@ 
init
 

---ci-provider <ci_provider>

+--ci-provider <ci_provider>
 
options: [‘github-actions’, ‘gitlab-ci’, ‘none’]

 

 
Default:

-
CiEnum.none

+
<CiEnum.none: 'none'>

 

 
Options:

 
github-actions | gitlab-ci | none

@@ -358,11 +356,11 @@ 
init
 

---terraform-state <terraform_state>

+--terraform-state <terraform_state>
 
options: [‘remote’, ‘local’, ‘existing’]

 

 
Default:

-
TerraformStateEnum.remote

+
<TerraformStateEnum.remote: 'remote'>

 

 
Options:

 
remote | local | existing

@@ -372,22 +370,23 @@ 
init
 

---kubernetes-version <kubernetes_version>

-

+--kubernetes-version <kubernetes_version>
+
The Kubernetes version you want to deploy your Nebari cluster to, leave blank for latest version

+

 
Default:

-
latest

+
'latest'

 

 

 

 
 

 

---ssl-cert-email <ssl_cert_email>

+--ssl-cert-email <ssl_cert_email>
 

 
 

 

---disable-prompt, --no-disable-prompt

+--disable-prompt, --no-disable-prompt
 

 
Default:

 
False

@@ -397,11 +396,22 @@ 
init
 

--o, --output <output>

+-o, --output <output>
 
Output file path for the rendered config file.

 

 
Default:

-
nebari-config.yaml

+
PosixPath('nebari-config.yaml')

+

+

+

+
+

+

+-e, --explicit

+
Write explicit nebari config file (advanced users only).

+

+
Default:

+
0

 

 

 

@@ -409,19 +419,20 @@ 
initArguments

 

 

-CLOUD_PROVIDER

+CLOUD_PROVIDER
 
Optional argument

+
options: [‘local’, ‘existing’, ‘aws’, ‘gcp’, ‘azure’]

-

keycloak

+

keycloak

Interact with the Nebari Keycloak identity and access management tool.

nebari keycloak [OPTIONS] COMMAND [ARGS]...
-

adduser

+

adduser

Add a user to Keycloak. User will be automatically added to the [italic]analyst[/italic] group.

nebari keycloak adduser [OPTIONS]
@@ -429,19 +440,19 @@

adduserOptions

---user <add_users>
+--user <add_users>

Required Provide both: <username> <password>

--c, --config <config_filename>
+-c, --config <config_filename>

Required nebari configuration file path

-

export-users

+

export-users

Export the users in Keycloak.

nebari keycloak export-users [OPTIONS]
@@ -449,24 +460,24 @@

export-usersOptions

--c, --config <config_filename>
+-c, --config <config_filename>

Required nebari configuration file path

---realm <realm>
+--realm <realm>

realm from which users are to be exported

Default:
-

nebari

+

'nebari'

-

listusers

+

listusers

List the users in Keycloak.

nebari keycloak listusers [OPTIONS]
@@ -474,14 +485,14 @@

listusersOptions

--c, --config <config_filename>
+-c, --config <config_filename>

Required nebari configuration file path

-

render

+

render

Dynamically render the Terraform scripts and other files from your [purple]nebari-config.yaml[/purple] file.

nebari render [OPTIONS]
@@ -489,24 +500,24 @@

renderOptions

--o, --output <output_directory>
+-o, --output <output_directory>

output directory

Default:
-

./

+

'./'

--c, --config <config_filename>
+-c, --config <config_filename>

Required nebari configuration yaml file path

---dry-run
+--dry-run

simulate rendering files without actually writing or updating any files

Default:
@@ -517,7 +528,7 @@

render -

support

+

support

Support tool to write all Kubernetes logs locally and compress them into a zip file.

The Nebari team recommends k9s to manage and inspect the state of the cluster. However, this command occasionally helpful for debugging purposes should the logs need to be shared.

@@ -527,24 +538,24 @@

supportOptions

--c, --config <config_filename>
+-c, --config <config_filename>

Required nebari configuration file path

--o, --output <output>
+-o, --output <output>

output filename

Default:
-

./nebari-support-logs.zip

+

'./nebari-support-logs.zip'

-

upgrade

+

upgrade

Upgrade your [purple]nebari-config.yaml[/purple].

Upgrade your [purple]nebari-config.yaml[/purple] after an nebari upgrade. If necessary, prompts users to perform manual upgrade steps required for the deploy process.

See the project [green]RELEASE.md[/green] for details.

@@ -554,13 +565,13 @@

upgradeOptions

--c, --config <config_filename>
+-c, --config <config_filename>

Required nebari configuration file path

---attempt-fixes
+--attempt-fixes

Attempt to fix the config for any incompatibilities between your old and new Nebari versions.

Default:
@@ -571,7 +582,7 @@

upgrade -

validate

+

validate

Validate the values in the [purple]nebari-config.yaml[/purple] file are acceptable.

nebari validate [OPTIONS]
@@ -579,13 +590,13 @@

validateOptions

--c, --config <config_filename>
+-c, --config <config_filename>

Required nebari configuration yaml file path, please pass in as -c/–config flag

---enable-commenting
+--enable-commenting

Toggle PR commenting on GitHub Actions

Default:
@@ -603,7 +614,7 @@

validate +
- ©2023, Nebari. + ©2023, Nebari. | - Powered by Sphinx 6.1.3 - & Alabaster 0.7.13 + Powered by Sphinx 8.1.3 + & Alabaster 1.0.0 |