-

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

@@ -395,13 +394,30 @@ 
init
+

+-s, --config-set <config_set>

+
Apply a pre-defined set of nebari configuration options.

+

+
 

 

--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 +425,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 +446,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 +466,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 +491,28 @@

listusersOptions

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

Required nebari configuration file path

+

+
+
+

plugin

+

Interact with nebari plugins

+
nebari plugin [OPTIONS] COMMAND [ARGS]...
+
+
+
+

list

+

List installed plugins

+
nebari plugin list [OPTIONS]
+
+
-

render

+

render

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

nebari render [OPTIONS]
@@ -489,24 +520,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 +548,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 +558,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 +585,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 +602,7 @@

upgrade -

validate

+

validate

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

nebari validate [OPTIONS]
@@ -579,13 +610,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 +634,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 | Dict[str, Any]: config = { "provider": cloud_provider, @@ -176,13 +178,17 @@ def render_config( config["certificate"] = {"type": CertificateEnum.letsencrypt.value} config["certificate"]["acme_email"] = ssl_cert_email + if config_set: + config_set = read_config_set(config_set) + config = utils.deep_merge(config, config_set.config) + # validate configuration and convert to model from nebari.plugins import nebari_plugin_manager try: config_model = nebari_plugin_manager.config_schema.model_validate(config) except pydantic.ValidationError as e: - print(str(e)) + raise e if repository_auto_provision: match = re.search(github_url_regex, repository) diff --git a/src/_nebari/stages/infrastructure/__init__.py b/src/_nebari/stages/infrastructure/__init__.py index 243abd1608..553e520e3a 100644 --- a/src/_nebari/stages/infrastructure/__init__.py +++ b/src/_nebari/stages/infrastructure/__init__.py @@ -6,6 +6,7 @@ import re import sys import tempfile +import warnings from typing import Annotated, Any, Dict, List, Literal, Optional, Tuple, Type, Union from pydantic import ConfigDict, Field, field_validator, model_validator @@ -94,6 +95,7 @@ class AzureInputVars(schema.Base): name: str environment: str region: str + authorized_ip_ranges: List[str] = ["0.0.0.0/0"] kubeconfig_filename: str = get_kubeconfig_filename() kubernetes_version: str node_groups: Dict[str, AzureNodeGroupInputVars] @@ -104,6 +106,7 @@ class AzureInputVars(schema.Base): tags: Dict[str, str] = {} max_pods: Optional[int] = None network_profile: Optional[Dict[str, str]] = None + azure_policy_enabled: Optional[bool] = None workload_identity_enabled: bool = False @@ -360,6 +363,7 @@ class AzureProvider(schema.Base): region: str kubernetes_version: Optional[str] = None storage_account_postfix: str + authorized_ip_ranges: Optional[List[str]] = ["0.0.0.0/0"] resource_group_name: Optional[str] = None node_groups: Dict[str, AzureNodeGroup] = DEFAULT_AZURE_NODE_GROUPS storage_account_postfix: str @@ -370,6 +374,7 @@ class AzureProvider(schema.Base): network_profile: Optional[Dict[str, str]] = None max_pods: Optional[int] = None workload_identity_enabled: bool = False + azure_policy_enabled: Optional[bool] = None @model_validator(mode="before") @classmethod @@ -613,11 +618,23 @@ def check_provider(cls, data: Any) -> Any: data[provider] = provider_enum_model_map[provider]() else: # if the provider field is invalid, it won't be set when this validator is called - # so we need to check for it explicitly here, and set the `pre` to True + # so we need to check for it explicitly here, and set mode to "before" # TODO: this is a workaround, check if there is a better way to do this in Pydantic v2 raise ValueError( f"'{provider}' is not a valid enumeration member; permitted: local, existing, aws, gcp, azure" ) + set_providers = { + provider + for provider in provider_name_abbreviation_map.keys() + if provider in data and data[provider] + } + expected_provider_config = provider_enum_name_map[provider] + extra_provider_config = set_providers - {expected_provider_config} + if extra_provider_config: + warnings.warn( + f"Provider is set to {getattr(provider, 'value', provider)}, but configuration defined for other providers: {extra_provider_config}" + ) + else: set_providers = [ provider @@ -631,6 +648,7 @@ def check_provider(cls, data: Any) -> Any: data["provider"] = provider_name_abbreviation_map[set_providers[0]] elif num_providers == 0: data["provider"] = schema.ProviderEnum.local.value + return data @@ -784,6 +802,7 @@ def input_vars(self, stage_outputs: Dict[str, Dict[str, Any]]): environment=self.config.namespace, region=self.config.azure.region, kubernetes_version=self.config.azure.kubernetes_version, + authorized_ip_ranges=self.config.azure.authorized_ip_ranges, node_groups={ name: AzureNodeGroupInputVars( instance=node_group.instance, @@ -809,6 +828,7 @@ def input_vars(self, stage_outputs: Dict[str, Dict[str, Any]]): network_profile=self.config.azure.network_profile, max_pods=self.config.azure.max_pods, workload_identity_enabled=self.config.azure.workload_identity_enabled, + azure_policy_enabled=self.config.azure.azure_policy_enabled, ).model_dump() elif self.config.provider == schema.ProviderEnum.aws: return AWSInputVars( diff --git a/src/_nebari/stages/infrastructure/template/azure/main.tf b/src/_nebari/stages/infrastructure/template/azure/main.tf index 2d6e2e2afa..960b755f8c 100644 --- a/src/_nebari/stages/infrastructure/template/azure/main.tf +++ b/src/_nebari/stages/infrastructure/template/azure/main.tf @@ -28,6 +28,7 @@ module "kubernetes" { kubernetes_version = var.kubernetes_version tags = var.tags max_pods = var.max_pods + authorized_ip_ranges = var.authorized_ip_ranges network_profile = var.network_profile @@ -43,4 +44,5 @@ module "kubernetes" { vnet_subnet_id = var.vnet_subnet_id private_cluster_enabled = var.private_cluster_enabled workload_identity_enabled = var.workload_identity_enabled + azure_policy_enabled = var.azure_policy_enabled } diff --git a/src/_nebari/stages/infrastructure/template/azure/modules/kubernetes/main.tf b/src/_nebari/stages/infrastructure/template/azure/modules/kubernetes/main.tf index f093f048c6..f97f1f6383 100644 --- a/src/_nebari/stages/infrastructure/template/azure/modules/kubernetes/main.tf +++ b/src/_nebari/stages/infrastructure/template/azure/modules/kubernetes/main.tf @@ -4,6 +4,9 @@ resource "azurerm_kubernetes_cluster" "main" { location = var.location resource_group_name = var.resource_group_name tags = var.tags + api_server_access_profile { + authorized_ip_ranges = var.authorized_ip_ranges + } # To enable Azure AD Workload Identity oidc_issuer_enabled must be set to true. oidc_issuer_enabled = var.workload_identity_enabled @@ -15,6 +18,9 @@ resource "azurerm_kubernetes_cluster" "main" { # Azure requires that a new, non-existent Resource Group is used, as otherwise the provisioning of the Kubernetes Service will fail. node_resource_group = var.node_resource_group_name private_cluster_enabled = var.private_cluster_enabled + # https://learn.microsoft.com/en-ie/azure/governance/policy/concepts/policy-for-kubernetes + azure_policy_enabled = var.azure_policy_enabled + dynamic "network_profile" { for_each = var.network_profile != null ? [var.network_profile] : [] diff --git a/src/_nebari/stages/infrastructure/template/azure/modules/kubernetes/variables.tf b/src/_nebari/stages/infrastructure/template/azure/modules/kubernetes/variables.tf index b93a9fae2d..95d2045420 100644 --- a/src/_nebari/stages/infrastructure/template/azure/modules/kubernetes/variables.tf +++ b/src/_nebari/stages/infrastructure/template/azure/modules/kubernetes/variables.tf @@ -76,3 +76,15 @@ variable "workload_identity_enabled" { type = bool default = false } + +variable "authorized_ip_ranges" { + description = "The ip range allowed to access the Kubernetes API server, defaults to 0.0.0.0/0" + type = list(string) + default = ["0.0.0.0/0"] +} + +variable "azure_policy_enabled" { + description = "Enable Azure Policy" + type = bool + default = false +} diff --git a/src/_nebari/stages/infrastructure/template/azure/variables.tf b/src/_nebari/stages/infrastructure/template/azure/variables.tf index dcef2c97cb..44ef90463f 100644 --- a/src/_nebari/stages/infrastructure/template/azure/variables.tf +++ b/src/_nebari/stages/infrastructure/template/azure/variables.tf @@ -82,3 +82,15 @@ variable "workload_identity_enabled" { type = bool default = false } + +variable "authorized_ip_ranges" { + description = "The ip range allowed to access the Kubernetes API server, defaults to 0.0.0.0/0" + type = list(string) + default = ["0.0.0.0/0"] +} + +variable "azure_policy_enabled" { + description = "Enable Azure Policy" + type = bool + default = false +} diff --git a/src/_nebari/stages/kubernetes_services/template/modules/kubernetes/services/conda-store/config/conda_store_config.py b/src/_nebari/stages/kubernetes_services/template/modules/kubernetes/services/conda-store/config/conda_store_config.py index ad9b79843a..f14c352973 100644 --- a/src/_nebari/stages/kubernetes_services/template/modules/kubernetes/services/conda-store/config/conda_store_config.py +++ b/src/_nebari/stages/kubernetes_services/template/modules/kubernetes/services/conda-store/config/conda_store_config.py @@ -10,9 +10,10 @@ from pathlib import Path import requests -from conda_store_server import api, orm, schema +from conda_store_server import api +from conda_store_server._internal import schema +from conda_store_server._internal.server.dependencies import get_conda_store from conda_store_server.server.auth import GenericOAuthAuthentication -from conda_store_server.server.dependencies import get_conda_store from conda_store_server.storage import S3Storage @@ -422,8 +423,7 @@ async def authenticate(self, request): for namespace in namespaces: _namespace = api.get_namespace(db, name=namespace) if _namespace is None: - db.add(orm.Namespace(name=namespace)) - db.commit() + api.ensure_namespace(db, name=namespace) return schema.AuthenticationToken( primary_namespace=username, diff --git a/src/_nebari/subcommands/info.py b/src/_nebari/subcommands/info.py index 1a36afceb1..340ff9d26a 100644 --- a/src/_nebari/subcommands/info.py +++ b/src/_nebari/subcommands/info.py @@ -10,12 +10,16 @@ @hookimpl def nebari_subcommand(cli: typer.Typer): + EXTERNAL_PLUGIN_STYLE = "cyan" + @cli.command() def info(ctx: typer.Context): from nebari.plugins import nebari_plugin_manager rich.print(f"Nebari version: {__version__}") + external_plugins = nebari_plugin_manager.get_external_plugins() + hooks = collections.defaultdict(list) for plugin in nebari_plugin_manager.plugin_manager.get_plugins(): for hook in nebari_plugin_manager.plugin_manager.get_hookcallers(plugin): @@ -27,7 +31,8 @@ def info(ctx: typer.Context): for hook_name, modules in hooks.items(): for module in modules: - table.add_row(hook_name, module) + style = EXTERNAL_PLUGIN_STYLE if module in external_plugins else None + table.add_row(hook_name, module, style=style) rich.print(table) @@ -36,8 +41,14 @@ def info(ctx: typer.Context): table.add_column("priority") table.add_column("module") for stage in nebari_plugin_manager.ordered_stages: + style = ( + EXTERNAL_PLUGIN_STYLE if stage.__module__ in external_plugins else None + ) table.add_row( - stage.name, str(stage.priority), f"{stage.__module__}.{stage.__name__}" + stage.name, + str(stage.priority), + f"{stage.__module__}.{stage.__name__}", + style=style, ) rich.print(table) diff --git a/src/_nebari/subcommands/init.py b/src/_nebari/subcommands/init.py index e794841ea7..c2f8d416e9 100644 --- a/src/_nebari/subcommands/init.py +++ b/src/_nebari/subcommands/init.py @@ -93,6 +93,7 @@ class InitInputs(schema.Base): region: Optional[str] = None ssl_cert_email: Optional[schema.email_pydantic] = None disable_prompt: bool = False + config_set: Optional[str] = None output: pathlib.Path = pathlib.Path("nebari-config.yaml") explicit: int = 0 @@ -134,6 +135,7 @@ def handle_init(inputs: InitInputs, config_schema: BaseModel): terraform_state=inputs.terraform_state, ssl_cert_email=inputs.ssl_cert_email, disable_prompt=inputs.disable_prompt, + config_set=inputs.config_set, ) try: @@ -496,6 +498,12 @@ def init( False, is_eager=True, ), + config_set: str = typer.Option( + None, + "--config-set", + "-s", + help="Apply a pre-defined set of nebari configuration options.", + ), output: str = typer.Option( pathlib.Path("nebari-config.yaml"), "--output", @@ -554,6 +562,7 @@ def init( inputs.terraform_state = terraform_state inputs.ssl_cert_email = ssl_cert_email inputs.disable_prompt = disable_prompt + inputs.config_set = config_set inputs.output = output inputs.explicit = explicit diff --git a/src/_nebari/subcommands/plugin.py b/src/_nebari/subcommands/plugin.py new file mode 100644 index 0000000000..28305848cd --- /dev/null +++ b/src/_nebari/subcommands/plugin.py @@ -0,0 +1,42 @@ +from importlib.metadata import version + +import rich +import typer +from rich.table import Table + +from nebari.hookspecs import hookimpl + + +@hookimpl +def nebari_subcommand(cli: typer.Typer): + plugin_cmd = typer.Typer( + add_completion=False, + no_args_is_help=True, + rich_markup_mode="rich", + context_settings={"help_option_names": ["-h", "--help"]}, + ) + + cli.add_typer( + plugin_cmd, + name="plugin", + help="Interact with nebari plugins", + rich_help_panel="Additional Commands", + ) + + @plugin_cmd.command() + def list(ctx: typer.Context): + """ + List installed plugins + """ + from nebari.plugins import nebari_plugin_manager + + external_plugins = nebari_plugin_manager.get_external_plugins() + + table = Table(title="Plugins") + table.add_column("name", justify="left", no_wrap=True) + table.add_column("version", justify="left", no_wrap=True) + + for plugin in external_plugins: + table.add_row(plugin, version(plugin)) + + rich.print(table) diff --git a/src/_nebari/upgrade.py b/src/_nebari/upgrade.py index 4e3abe0a34..71795dfa1e 100644 --- a/src/_nebari/upgrade.py +++ b/src/_nebari/upgrade.py @@ -21,7 +21,7 @@ import rich from packaging.version import Version from pydantic import ValidationError -from rich.prompt import Prompt +from rich.prompt import Confirm, Prompt from typing_extensions import override from _nebari.config import backup_configuration @@ -48,6 +48,20 @@ UPGRADE_KUBERNETES_MESSAGE = "Please see the [green][link=https://www.nebari.dev/docs/how-tos/kubernetes-version-upgrade]Kubernetes upgrade docs[/link][/green] for more information." DESTRUCTIVE_UPGRADE_WARNING = "-> This version upgrade will result in your cluster being completely torn down and redeployed. Please ensure you have backed up any data you wish to keep before proceeding!!!" +TERRAFORM_REMOVE_TERRAFORM_STAGE_FILES_CONFIRMATION = ( + "Nebari needs to generate an updated set of Terraform scripts for your deployment and delete the old scripts.\n" + "Do you want Nebari to remove your [green]stages[/green] directory automatically for you? It will be recreated the next time Nebari is run.\n" + "[red]Warning:[/red] This will remove everything in the [green]stages[/green] directory.\n" + "If you do not have Nebari do it automatically here, you will need to remove the [green]stages[/green] manually with a command" + "like [green]rm -rf stages[/green]." +) +DESTROY_STAGE_FILES_WITH_TF_STATE_NOT_REMOTE = ( + "⚠️ CAUTION ⚠️\n" + "Nebari would like to remove your old Terraform/Opentofu [green]stages[/green] files. Your [blue]terraform_state[/blue] configuration is not set to [blue]remote[/blue], so destroying your [green]stages[/green] files could potentially be very detructive.\n" + "If you don't have active Terraform/Opentofu deployment state files contained within your [green]stages[/green] directory, you may proceed by entering [red]y[/red] at the prompt." + "If you have an active Terraform/Opentofu deployment with active state files in your [green]stages[/green] folder, you will need to either bring Nebari down temporarily to redeploy or pursue some other means to upgrade. Enter [red]n[/red] at the prompt.\n\n" + "Do you want to proceed by deleting your [green]stages[/green] directory and everything in it? ([red]POTENTIALLY VERY DESTRUCTIVE[/red])" +) def do_upgrade(config_filename, attempt_fixes=False): @@ -214,6 +228,54 @@ def upgrade( return config + @classmethod + def _rm_rf_stages(cls, config_filename, dry_run: bool = False, verbose=False): + """ + Remove stage files during and upgrade step + + Usually used when you need files in your `stages` directory to be + removed in order to avoid resource conflicts + + Args: + config_filename (str): The path to the configuration file. + Returns: + None + """ + config_dir = Path(config_filename).resolve().parent + + if Path.is_dir(config_dir): + stage_dir = config_dir / "stages" + + stage_filenames = [d for d in stage_dir.rglob("*") if d.is_file()] + + for stage_filename in stage_filenames: + if dry_run and verbose: + rich.print(f"Dry run: Would remove {stage_filename}") + else: + stage_filename.unlink(missing_ok=True) + if verbose: + rich.print(f"Removed {stage_filename}") + + stage_filedirs = sorted( + (d for d in stage_dir.rglob("*") if d.is_dir()), + reverse=True, + ) + + for stage_filedir in stage_filedirs: + if dry_run and verbose: + rich.print(f"Dry run: Would remove {stage_filedir}") + else: + stage_filedir.rmdir() + if verbose: + rich.print(f"Removed {stage_filedir}") + + if dry_run and verbose: + rich.print(f"Dry run: Would remove {stage_dir}") + elif stage_dir.is_dir(): + stage_dir.rmdir() + if verbose: + rich.print(f"Removed {stage_dir}") + def get_version(self): """ Returns: @@ -307,7 +369,9 @@ def replace_image_tag_legacy( return ":".join([m.groups()[0], f"v{new_version}"]) return None - def replace_image_tag(s: str, new_version: str, config_path: str) -> str: + def replace_image_tag( + s: str, new_version: str, config_path: str, attempt_fixes: bool + ) -> str: """ Replace the image tag with the new version. @@ -329,11 +393,11 @@ def replace_image_tag(s: str, new_version: str, config_path: str) -> str: if current_tag == new_version: return s loc = f"{config_path}: {image_name}" - response = Prompt.ask( - f"\nDo you want to replace current tag [green]{current_tag}[/green] with [green]{new_version}[/green] for:\n[purple]{loc}[/purple]? [Y/n] ", - default="Y", + response = attempt_fixes or Confirm.ask( + f"\nDo you want to replace current tag [green]{current_tag}[/green] with [green]{new_version}[/green] for:\n[purple]{loc}[/purple]?", + default=True, ) - if response.lower() in ["y", "yes", ""]: + if response: return s.replace(current_tag, new_version) else: return s @@ -364,7 +428,11 @@ def set_nested_item(config: dict, config_path: list, value: str): config[config_path[-1]] = value def update_image_tag( - config: dict, config_path: str, current_image: str, new_version: str + config: dict, + config_path: str, + current_image: str, + new_version: str, + attempt_fixes: bool, ) -> dict: """ Update the image tag in the configuration. @@ -378,7 +446,12 @@ def update_image_tag( Returns: dict: The updated configuration dictionary. """ - new_image = replace_image_tag(current_image, new_version, config_path) + new_image = replace_image_tag( + current_image, + new_version, + config_path, + attempt_fixes, + ) if new_image != current_image: set_nested_item(config, config_path, new_image) @@ -388,7 +461,11 @@ def update_image_tag( for k, v in config.get("default_images", {}).items(): config_path = f"default_images.{k}" config = update_image_tag( - config, config_path, v, __rounded_finish_version__ + config, + config_path, + v, + __rounded_finish_version__, + kwargs.get("attempt_fixes", False), ) # update profiles.jupyterlab images @@ -400,6 +477,7 @@ def update_image_tag( f"profiles.jupyterlab.{i}.kubespawner_override.image", current_image, __rounded_finish_version__, + kwargs.get("attempt_fixes", False), ) # update profiles.dask_worker images @@ -411,11 +489,16 @@ def update_image_tag( f"profiles.dask_worker.{k}.image", current_image, __rounded_finish_version__, + kwargs.get("attempt_fixes", False), ) # Run any version-specific tasks return self._version_specific_upgrade( - config, start_version, config_filename, *args, **kwargs + config, + start_version, + config_filename, + *args, + **kwargs, ) def _version_specific_upgrade( @@ -629,27 +712,93 @@ def _version_specific_upgrade( """ Prompt users to delete Argo CRDs """ + argo_crds = [ + "clusterworkflowtemplates.argoproj.io", + "cronworkflows.argoproj.io", + "workfloweventbindings.argoproj.io", + "workflows.argoproj.io", + "workflowtasksets.argoproj.io", + "workflowtemplates.argoproj.io", + ] - kubectl_delete_argo_crds_cmd = "kubectl delete crds clusterworkflowtemplates.argoproj.io cronworkflows.argoproj.io workfloweventbindings.argoproj.io workflows.argoproj.io workflowtasksets.argoproj.io workflowtemplates.argoproj.io" + argo_sa = ["argo-admin", "argo-dev", "argo-view"] - kubectl_delete_argo_sa_cmd = ( - f"kubectl delete sa -n {config['namespace']} argo-admin argo-dev argo-view" - ) + namespace = config.get("namespace", "default") - rich.print( - f"\n\n[bold cyan]Note:[/] Upgrading requires a one-time manual deletion of the Argo Workflows Custom Resource Definitions (CRDs) and service accounts. \n\n[red bold]Warning: [link=https://{config['domain']}/argo/workflows]Workflows[/link] and [link=https://{config['domain']}/argo/workflows]CronWorkflows[/link] created before deleting the CRDs will be erased when the CRDs are deleted and will not be restored.[/red bold] \n\nThe updated CRDs will be installed during the next [cyan bold]nebari deploy[/cyan bold] step. Argo Workflows will not function after deleting the CRDs until the updated CRDs and service accounts are installed in the next nebari deploy. You must delete the Argo Workflows CRDs and service accounts before upgrading to {self.version} (or later) or the deploy step will fail. Please delete them before proceeding by generating a kubeconfig (see [link=https://www.nebari.dev/docs/how-tos/debug-nebari/#generating-the-kubeconfig]docs[/link]), installing kubectl (see [link=https://www.nebari.dev/docs/how-tos/debug-nebari#installing-kubectl]docs[/link]), and running the following two commands:\n\n\t[cyan bold]{kubectl_delete_argo_crds_cmd} [/cyan bold]\n\n\t[cyan bold]{kubectl_delete_argo_sa_cmd} [/cyan bold]" - "" - ) + if kwargs.get("attempt_fixes", False): + try: + kubernetes.config.load_kube_config() + except kubernetes.config.config_exception.ConfigException: + rich.print( + "[red bold]No default kube configuration file was found. Make sure to [link=https://www.nebari.dev/docs/how-tos/debug-nebari#generating-the-kubeconfig]have one pointing to your Nebari cluster[/link] before upgrading.[/red bold]" + ) + exit() - continue_ = Prompt.ask( - "Have you deleted the Argo Workflows CRDs and service accounts? [y/N] ", - default="N", - ) - if not continue_ == "y": + for crd in argo_crds: + api_instance = kubernetes.client.ApiextensionsV1Api() + try: + api_instance.delete_custom_resource_definition( + name=crd, + ) + except kubernetes.client.exceptions.ApiException as e: + if e.status == 404: + rich.print(f"CRD [yellow]{crd}[/yellow] not found. Ignoring.") + else: + raise e + else: + rich.print(f"Successfully removed CRD [green]{crd}[/green]") + + for sa in argo_sa: + api_instance = kubernetes.client.CoreV1Api() + try: + api_instance.delete_namespaced_service_account( + sa, + namespace, + ) + except kubernetes.client.exceptions.ApiException as e: + if e.status == 404: + rich.print( + f"Service account [yellow]{sa}[/yellow] not found. Ignoring." + ) + else: + raise e + else: + rich.print( + f"Successfully removed service account [green]{sa}[/green]" + ) + else: + kubectl_delete_argo_crds_cmd = " ".join( + ( + *("kubectl delete crds",), + *argo_crds, + ), + ) + kubectl_delete_argo_sa_cmd = " ".join( + ( + *( + "kubectl delete sa", + f"-n {namespace}", + ), + *argo_sa, + ), + ) rich.print( - f"You must delete the Argo Workflows CRDs and service accounts before upgrading to [green]{self.version}[/green] (or later)." + f"\n\n[bold cyan]Note:[/] Upgrading requires a one-time manual deletion of the Argo Workflows Custom Resource Definitions (CRDs) and service accounts. \n\n[red bold]" + f"Warning: [link=https://{config['domain']}/argo/workflows]Workflows[/link] and [link=https://{config['domain']}/argo/workflows]CronWorkflows[/link] created before deleting the CRDs will be erased when the CRDs are deleted and will not be restored.[/red bold] \n\n" + f"The updated CRDs will be installed during the next [cyan bold]nebari deploy[/cyan bold] step. Argo Workflows will not function after deleting the CRDs until the updated CRDs and service accounts are installed in the next nebari deploy. " + f"You must delete the Argo Workflows CRDs and service accounts before upgrading to {self.version} (or later) or the deploy step will fail. " + f"Please delete them before proceeding by generating a kubeconfig (see [link=https://www.nebari.dev/docs/how-tos/debug-nebari/#generating-the-kubeconfig]docs[/link]), installing kubectl (see [link=https://www.nebari.dev/docs/how-tos/debug-nebari#installing-kubectl]docs[/link]), and running the following two commands:\n\n\t[cyan bold]{kubectl_delete_argo_crds_cmd} [/cyan bold]\n\n\t[cyan bold]{kubectl_delete_argo_sa_cmd} [/cyan bold]" ) - exit() + + continue_ = Confirm.ask( + "Have you deleted the Argo Workflows CRDs and service accounts?", + default=False, + ) + if not continue_: + rich.print( + f"You must delete the Argo Workflows CRDs and service accounts before upgrading to [green]{self.version}[/green] (or later)." + ) + exit() return config @@ -682,11 +831,11 @@ def _version_specific_upgrade( ): argo = config.get("argo_workflows", {}) if argo.get("enabled"): - response = Prompt.ask( - f"\nDo you want to enable the [green][link={NEBARI_WORKFLOW_CONTROLLER_DOCS}]Nebari Workflow Controller[/link][/green], required for [green][link={ARGO_JUPYTER_SCHEDULER_REPO}]Argo-Jupyter-Scheduler[/link][green]? [Y/n] ", - default="Y", + response = kwargs.get("attempt_fixes", False) or Confirm.ask( + f"\nDo you want to enable the [green][link={NEBARI_WORKFLOW_CONTROLLER_DOCS}]Nebari Workflow Controller[/link][/green], required for [green][link={ARGO_JUPYTER_SCHEDULER_REPO}]Argo-Jupyter-Scheduler[/link][green]?", + default=True, ) - if response.lower() in ["y", "yes", ""]: + if response: argo["nebari_workflow_controller"] = {"enabled": True} rich.print("\n ⚠️ Deprecation Warnings ⚠️") @@ -726,9 +875,6 @@ def _version_specific_upgrade( rich.print( "-> Data should be backed up before performing this upgrade ([green][link=https://www.nebari.dev/docs/how-tos/manual-backup]see docs[/link][/green]) The 'prevent_deploy' flag has been set in your config file and must be manually removed to deploy." ) - rich.print( - "-> Please also run the [green]rm -rf stages[/green] so that we can regenerate an updated set of Terraform scripts for your deployment." - ) # Setting the following flag will prevent deployment and display guidance to the user # which they can override if they are happy they understand the situation. @@ -812,6 +958,26 @@ def _version_specific_upgrade( rich.print("\n ⚠️ DANGER ⚠️") rich.print(DESTRUCTIVE_UPGRADE_WARNING) + if kwargs.get("attempt_fixes", False) or Confirm.ask( + TERRAFORM_REMOVE_TERRAFORM_STAGE_FILES_CONFIRMATION, + default=False, + ): + if ( + (_terraform_state_config := config.get("terraform_state")) + and (_terraform_state_config.get("type") != "remote") + and not Confirm.ask( + DESTROY_STAGE_FILES_WITH_TF_STATE_NOT_REMOTE, + default=False, + ) + ): + exit() + + self._rm_rf_stages( + config_filename, + dry_run=kwargs.get("dry_run", False), + verbose=True, + ) + return config @@ -829,15 +995,31 @@ class Upgrade_2023_11_1(UpgradeStep): def _version_specific_upgrade( self, config, start_version, config_filename: Path, *args, **kwargs ): - rich.print("\n ⚠️ Warning ⚠️") - rich.print( - "-> Please run the [green]rm -rf stages[/green] so that we can regenerate an updated set of Terraform scripts for your deployment." - ) rich.print("\n ⚠️ Deprecation Warning ⚠️") rich.print( f"-> ClearML, Prefect and kbatch are no longer supported in Nebari version [green]{self.version}[/green] and will be uninstalled." ) + if kwargs.get("attempt_fixes", False) or Confirm.ask( + TERRAFORM_REMOVE_TERRAFORM_STAGE_FILES_CONFIRMATION, + default=False, + ): + if ( + (_terraform_state_config := config.get("terraform_state")) + and (_terraform_state_config.get("type") != "remote") + and not Confirm.ask( + DESTROY_STAGE_FILES_WITH_TF_STATE_NOT_REMOTE, + default=False, + ) + ): + exit() + + self._rm_rf_stages( + config_filename, + dry_run=kwargs.get("dry_run", False), + verbose=True, + ) + return config @@ -855,16 +1037,32 @@ class Upgrade_2023_12_1(UpgradeStep): def _version_specific_upgrade( self, config, start_version, config_filename: Path, *args, **kwargs ): - rich.print("\n ⚠️ Warning ⚠️") - rich.print( - "-> Please run the [green]rm -rf stages[/green] so that we can regenerate an updated set of Terraform scripts for your deployment." - ) rich.print("\n ⚠️ Deprecation Warning ⚠️") rich.print( f"-> [green]{self.version}[/green] is the last Nebari version that supports the jupyterlab-videochat extension." ) rich.print() + if kwargs.get("attempt_fixes", False) or Confirm.ask( + TERRAFORM_REMOVE_TERRAFORM_STAGE_FILES_CONFIRMATION, + default=False, + ): + if ( + (_terraform_state_config := config.get("terraform_state")) + and (_terraform_state_config.get("type") != "remote") + and not Confirm.ask( + DESTROY_STAGE_FILES_WITH_TF_STATE_NOT_REMOTE, + default=False, + ) + ): + exit() + + self._rm_rf_stages( + config_filename, + dry_run=kwargs.get("dry_run", False), + verbose=True, + ) + return config @@ -882,10 +1080,6 @@ class Upgrade_2024_1_1(UpgradeStep): def _version_specific_upgrade( self, config, start_version, config_filename: Path, *args, **kwargs ): - rich.print("\n ⚠️ Warning ⚠️") - rich.print( - "-> Please run the [green]rm -rf stages[/green] so that we can regenerate an updated set of Terraform scripts for your deployment." - ) rich.print("\n ⚠️ Deprecation Warning ⚠️") rich.print( "-> jupyterlab-videochat, retrolab, jupyter-tensorboard, jupyterlab-conda-store and jupyter-nvdashboard", @@ -893,6 +1087,26 @@ def _version_specific_upgrade( ) rich.print() + if kwargs.get("attempt_fixes", False) or Confirm.ask( + TERRAFORM_REMOVE_TERRAFORM_STAGE_FILES_CONFIRMATION, + default=False, + ): + if ( + (_terraform_state_config := config.get("terraform_state")) + and (_terraform_state_config.get("type") != "remote") + and not Confirm.ask( + DESTROY_STAGE_FILES_WITH_TF_STATE_NOT_REMOTE, + default=False, + ) + ): + exit() + + self._rm_rf_stages( + config_filename, + dry_run=kwargs.get("dry_run", False), + verbose=True, + ) + return config @@ -958,12 +1172,11 @@ def _version_specific_upgrade( default_node_groups = provider_enum_default_node_groups_map[ provider ] - continue_ = Prompt.ask( + continue_ = kwargs.get("attempt_fixes", False) or Confirm.ask( f"Would you like to include the default configuration for the node groups in [purple]{config_filename}[/purple]?", - choices=["y", "N"], - default="N", + default=False, ) - if continue_ == "y": + if continue_: config[provider_full_name]["node_groups"] = default_node_groups except KeyError: pass @@ -1000,7 +1213,6 @@ def _version_specific_upgrade( ): # Prompt users to manually update kube-prometheus-stack CRDs if monitoring is enabled if config.get("monitoring", {}).get("enabled", True): - crd_urls = [ "https://raw.githubusercontent.com/prometheus-operator/prometheus-operator/v0.73.0/example/prometheus-operator-crd/monitoring.coreos.com_alertmanagerconfigs.yaml", "https://raw.githubusercontent.com/prometheus-operator/prometheus-operator/v0.73.0/example/prometheus-operator-crd/monitoring.coreos.com_alertmanagers.yaml", @@ -1030,10 +1242,9 @@ def _version_specific_upgrade( "\n-> [red bold]Nebari version 2024.6.1 comes with a new version of Grafana. Any custom dashboards that you created will be deleted after upgrading Nebari. Make sure to [link=https://grafana.com/docs/grafana/latest/dashboards/share-dashboards-panels/#export-a-dashboard-as-json]export them as JSON[/link] so you can [link=https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/import-dashboards/#import-a-dashboard]import them[/link] again afterwards.[/red bold]" f"\n-> [red bold]Before upgrading, kube-prometheus-stack CRDs need to be updated and the {daemonset_name} daemonset needs to be deleted.[/red bold]" ) - run_commands = Prompt.ask( + run_commands = kwargs.get("attempt_fixes", False) or Confirm.ask( "\nDo you want Nebari to update the kube-prometheus-stack CRDs and delete the prometheus-node-exporter for you? If not, you'll have to do it manually.", - choices=["y", "N"], - default="N", + default=False, ) # By default, rich wraps lines by splitting them into multiple lines. This is @@ -1041,7 +1252,7 @@ def _version_specific_upgrade( # To avoid this, we use a rich console with a larger width to print the entire commands # and let the terminal wrap them if needed. console = rich.console.Console(width=220) - if run_commands == "y": + if run_commands: try: kubernetes.config.load_kube_config() except kubernetes.config.config_exception.ConfigException: @@ -1054,10 +1265,14 @@ def _version_specific_upgrade( rich.print( f"The following commands will be run for the [cyan bold]{cluster_name}[/cyan bold] cluster" ) - Prompt.ask("Hit enter to show the commands") + _ = kwargs.get("attempt_fixes", False) or Prompt.ask( + "Hit enter to show the commands" + ) console.print(commands) - Prompt.ask("Hit enter to continue") + _ = kwargs.get("attempt_fixes", False) or Prompt.ask( + "Hit enter to continue" + ) # We need to add a special constructor to the yaml loader to handle a specific # tag as otherwise the kubernetes API will fail when updating the CRD. yaml.constructor.add_constructor( @@ -1099,16 +1314,15 @@ def _version_specific_upgrade( rich.print( "[red bold]Before upgrading, you need to manually delete the prometheus-node-exporter daemonset and update the kube-prometheus-stack CRDs. To do that, please run the following commands.[/red bold]" ) - Prompt.ask("Hit enter to show the commands") + _ = Prompt.ask("Hit enter to show the commands") console.print(commands) - Prompt.ask("Hit enter to continue") - continue_ = Prompt.ask( + _ = Prompt.ask("Hit enter to continue") + continue_ = Confirm.ask( f"Have you backed up your custom dashboards (if necessary), deleted the {daemonset_name} daemonset and updated the kube-prometheus-stack CRDs?", - choices=["y", "N"], - default="N", + default=False, ) - if not continue_ == "y": + if not continue_: rich.print( f"[red bold]You must back up your custom dashboards (if necessary), delete the {daemonset_name} daemonset and update the kube-prometheus-stack CRDs before upgrading to [green]{self.version}[/green] (or later).[/bold red]" ) @@ -1133,12 +1347,11 @@ def _version_specific_upgrade( If not, select "N" and the old default node groups will be added to the nebari config file. """ ) - continue_ = Prompt.ask( + continue_ = kwargs.get("attempt_fixes", False) or Confirm.ask( text, - choices=["y", "N"], - default="y", + default=True, ) - if continue_ == "N": + if not continue_: config[provider_full_name]["node_groups"] = { "general": { "instance": "n1-standard-8", @@ -1179,8 +1392,9 @@ def _version_specific_upgrade( }, indent=4, ) - text += "\n\nHit enter to continue" - Prompt.ask(text) + rich.print(text) + if not kwargs.get("attempt_fixes", False): + _ = Prompt.ask("\n\nHit enter to continue") return config @@ -1283,13 +1497,10 @@ def _version_specific_upgrade( keycloak_admin = None # Prompt the user for role assignment (if yes, transforms the response into bool) - assign_roles = ( - Prompt.ask( - "[bold]Would you like Nebari to assign the corresponding role/scopes to all of your current groups automatically?[/bold]", - choices=["y", "N"], - default="N", - ).lower() - == "y" + # This needs to be monkeypatched and will be addressed in a future PR. Until then, this causes test failures. + assign_roles = kwargs.get("attempt_fixes", False) or Confirm.ask( + "[bold]Would you like Nebari to assign the corresponding role/scopes to all of your current groups automatically?[/bold]", + default=False, ) if assign_roles: diff --git a/src/_nebari/utils.py b/src/_nebari/utils.py index f3d62f353d..48b8a91e9b 100644 --- a/src/_nebari/utils.py +++ b/src/_nebari/utils.py @@ -160,7 +160,7 @@ def modified_environ(*remove: List[str], **update: Dict[str, str]): def deep_merge(*args): - """Deep merge multiple dictionaries. + """Deep merge multiple dictionaries. Preserves order in dicts and lists. >>> value_1 = { 'a': [1, 2], @@ -190,7 +190,7 @@ def deep_merge(*args): if isinstance(d1, dict) and isinstance(d2, dict): d3 = {} - for key in d1.keys() | d2.keys(): + for key in tuple(d1.keys()) + tuple(d2.keys()): if key in d1 and key in d2: d3[key] = deep_merge(d1[key], d2[key]) elif key in d1: diff --git a/src/nebari/plugins.py b/src/nebari/plugins.py index 71db0ade96..a6cb1aa688 100644 --- a/src/nebari/plugins.py +++ b/src/nebari/plugins.py @@ -19,6 +19,7 @@ "_nebari.subcommands.deploy", "_nebari.subcommands.destroy", "_nebari.subcommands.keycloak", + "_nebari.subcommands.plugin", "_nebari.subcommands.render", "_nebari.subcommands.support", "_nebari.subcommands.upgrade", @@ -121,6 +122,14 @@ def read_config(self, config_path: typing.Union[str, Path], **kwargs): return read_configuration(config_path, self.config_schema, **kwargs) + def get_external_plugins(self): + external_plugins = [] + all_plugins = DEFAULT_SUBCOMMAND_PLUGINS + DEFAULT_STAGES_PLUGINS + for plugin in self.plugin_manager.get_plugins(): + if plugin.__name__ not in all_plugins: + external_plugins.append(plugin.__name__) + return external_plugins + @property def ordered_stages(self): return self.get_available_stages() diff --git a/tests/common/handlers.py b/tests/common/handlers.py index 51964d3ac5..761a6efd88 100644 --- a/tests/common/handlers.py +++ b/tests/common/handlers.py @@ -298,7 +298,9 @@ def _open_conda_store_service(self): def _open_new_environment_tab(self): self.page.get_by_label("Create a new environment in").click() - expect(self.page.get_by_text("Create Environment")).to_be_visible() + expect( + self.page.get_by_role("button", name="Create", exact=True) + ).to_be_visible() def _assert_user_namespace(self): expect( diff --git a/tests/tests_unit/test_cli_plugin.py b/tests/tests_unit/test_cli_plugin.py new file mode 100644 index 0000000000..2f6257050e --- /dev/null +++ b/tests/tests_unit/test_cli_plugin.py @@ -0,0 +1,64 @@ +from typing import List +from unittest.mock import Mock, patch + +import pytest +from typer.testing import CliRunner + +from _nebari.cli import create_cli + +runner = CliRunner() + + +@pytest.mark.parametrize( + "args, exit_code, content", + [ + # --help + ([], 0, ["Usage:"]), + (["--help"], 0, ["Usage:"]), + (["-h"], 0, ["Usage:"]), + (["list", "--help"], 0, ["Usage:"]), + (["list", "-h"], 0, ["Usage:"]), + (["list"], 0, ["Plugins"]), + ], +) +def test_cli_plugin_stdout(args: List[str], exit_code: int, content: List[str]): + app = create_cli() + result = runner.invoke(app, ["plugin"] + args) + assert result.exit_code == exit_code + for c in content: + assert c in result.stdout + + +def mock_get_plugins(): + mytestexternalplugin = Mock() + mytestexternalplugin.__name__ = "mytestexternalplugin" + + otherplugin = Mock() + otherplugin.__name__ = "otherplugin" + + return [mytestexternalplugin, otherplugin] + + +def mock_version(pkg): + pkg_version_map = { + "mytestexternalplugin": "0.4.4", + "otherplugin": "1.1.1", + } + return pkg_version_map.get(pkg) + + +@patch( + "nebari.plugins.NebariPluginManager.plugin_manager.get_plugins", mock_get_plugins +) +@patch("_nebari.subcommands.plugin.version", mock_version) +def test_cli_plugin_list_external_plugins(): + app = create_cli() + result = runner.invoke(app, ["plugin", "list"]) + assert result.exit_code == 0 + expected_output = [ + "Plugins", + "mytestexternalplugin │ 0.4.4", + "otherplugin │ 1.1.1", + ] + for c in expected_output: + assert c in result.stdout diff --git a/tests/tests_unit/test_cli_upgrade.py b/tests/tests_unit/test_cli_upgrade.py index 8cbac5d573..364b51b23b 100644 --- a/tests/tests_unit/test_cli_upgrade.py +++ b/tests/tests_unit/test_cli_upgrade.py @@ -5,6 +5,7 @@ import pytest import yaml +from rich.prompt import Confirm, Prompt from typer.testing import CliRunner import _nebari.upgrade @@ -450,6 +451,24 @@ def test_cli_upgrade_to_2023_10_1_kubernetes_validations( "gcp": {"incompatible": "1.23", "compatible": "1.26", "invalid": "badname"}, } + def mock_input_ask(prompt, *args, **kwargs): + from _nebari.upgrade import TERRAFORM_REMOVE_TERRAFORM_STAGE_FILES_CONFIRMATION + + # For more about structural pattern matching, see: + # https://peps.python.org/pep-0636/ + match prompt: + case str(s) if s == TERRAFORM_REMOVE_TERRAFORM_STAGE_FILES_CONFIRMATION: + return kwargs.get("attempt_fixes", False) + case _: + return kwargs.get("default", False) + + monkeypatch.setattr(Confirm, "ask", mock_input_ask) + monkeypatch.setattr( + Prompt, + "ask", + lambda x, *args, **kwargs: "", + ) + with tempfile.TemporaryDirectory() as tmp: tmp_file = Path(tmp).resolve() / "nebari-config.yaml" assert tmp_file.exists() is False diff --git a/tests/tests_unit/test_config_set.py b/tests/tests_unit/test_config_set.py new file mode 100644 index 0000000000..81f5a8a11c --- /dev/null +++ b/tests/tests_unit/test_config_set.py @@ -0,0 +1,73 @@ +from unittest.mock import patch + +import pytest +from packaging.requirements import SpecifierSet + +from _nebari.config_set import ConfigSetMetadata, read_config_set + +test_version = "2024.12.2" + + +@pytest.mark.parametrize( + "version_input,test_version,should_pass", + [ + # Standard version tests + (">=2024.12.0,<2025.0.0", "2024.12.2", True), + (SpecifierSet(">=2024.12.0,<2025.0.0"), "2024.12.2", True), + # Pre-release version requirement tests + (">=2024.12.0rc1,<2025.0.0", "2024.12.0rc1", True), + (SpecifierSet(">=2024.12.0rc1"), "2024.12.0rc2", True), + # Pre-release test version against standard requirement + (">=2024.12.0,<2025.0.0", "2024.12.1rc1", True), + (SpecifierSet(">=2024.12.0,<2025.0.0"), "2024.12.1rc1", True), + # Failing cases + (">=2025.0.0", "2024.12.2rc1", False), + (SpecifierSet(">=2025.0.0rc1"), "2024.12.2", False), + ], +) +def test_version_requirement(version_input, test_version, should_pass): + metadata = ConfigSetMetadata(name="test-config", nebari_version=version_input) + + if should_pass: + metadata.check_version(test_version) + else: + with pytest.raises(ValueError) as exc_info: + metadata.check_version(test_version) + assert "Nebari version" in str(exc_info.value) + + +def test_read_config_set_valid(tmp_path): + config_set_yaml = """ + metadata: + name: test-config + nebari_version: ">=2024.12.0" + config: + key: value + """ + config_set_filepath = tmp_path / "config_set.yaml" + config_set_filepath.write_text(config_set_yaml) + with patch("_nebari.config_set.__version__", "2024.12.2"): + config_set = read_config_set(str(config_set_filepath)) + assert config_set.metadata.name == "test-config" + assert config_set.config["key"] == "value" + + +def test_read_config_set_invalid_version(tmp_path): + config_set_yaml = """ + metadata: + name: test-config + nebari_version: ">=2025.0.0" + config: + key: value + """ + config_set_filepath = tmp_path / "config_set.yaml" + config_set_filepath.write_text(config_set_yaml) + + with patch("_nebari.config_set.__version__", "2024.12.2"): + with pytest.raises(ValueError) as exc_info: + read_config_set(str(config_set_filepath)) + assert "Nebari version" in str(exc_info.value) + + +if __name__ == "__main__": + pytest.main() diff --git a/tests/tests_unit/test_schema.py b/tests/tests_unit/test_schema.py index 5c21aef8d6..e445ba37da 100644 --- a/tests/tests_unit/test_schema.py +++ b/tests/tests_unit/test_schema.py @@ -161,3 +161,13 @@ def test_set_provider(config_schema, provider): result_config_dict = config.model_dump() assert provider in result_config_dict assert result_config_dict[provider]["kube_context"] == "some_context" + + +def test_provider_config_mismatch_warning(config_schema): + config_dict = { + "project_name": "test", + "provider": "local", + "existing": {"kube_context": "some_context"}, # <-- Doesn't match the provider + } + with pytest.warns(UserWarning, match="configuration defined for other providers"): + config_schema(**config_dict) diff --git a/tests/tests_unit/test_stages.py b/tests/tests_unit/test_stages.py index c716d93030..c15aa6d9fc 100644 --- a/tests/tests_unit/test_stages.py +++ b/tests/tests_unit/test_stages.py @@ -53,6 +53,7 @@ def test_check_immutable_fields_immutable_change( mock_model_fields, mock_get_state, terraform_state_stage, mock_config ): old_config = mock_config.model_copy(deep=True) + old_config.local = None old_config.provider = schema.ProviderEnum.gcp mock_get_state.return_value = old_config.model_dump() diff --git a/tests/tests_unit/test_upgrade.py b/tests/tests_unit/test_upgrade.py index f681668261..8f4a62630b 100644 --- a/tests/tests_unit/test_upgrade.py +++ b/tests/tests_unit/test_upgrade.py @@ -2,7 +2,7 @@ from pathlib import Path import pytest -from rich.prompt import Prompt +from rich.prompt import Confirm, Prompt from _nebari.upgrade import do_upgrade from _nebari.version import __version__, rounded_ver_parse @@ -21,6 +21,36 @@ def qhub_users_import_json(): ) +class MockKeycloakAdmin: + @staticmethod + def get_client_id(*args, **kwargs): + return "test-client" + + @staticmethod + def create_client_role(*args, **kwargs): + return "test-client-role" + + @staticmethod + def get_client_role_id(*args, **kwargs): + return "test-client-role-id" + + @staticmethod + def get_role_by_id(*args, **kwargs): + return bytearray("test-role-id", "utf-8") + + @staticmethod + def get_groups(*args, **kwargs): + return [] + + @staticmethod + def get_client_role_groups(*args, **kwargs): + return [] + + @staticmethod + def assign_group_client_roles(*args, **kwargs): + pass + + @pytest.mark.parametrize( "old_qhub_config_path_str,attempt_fixes,expect_upgrade_error", [ @@ -49,34 +79,100 @@ def test_upgrade_4_0( qhub_users_import_json, monkeypatch, ): - def mock_input(prompt, **kwargs): + from _nebari.upgrade import TERRAFORM_REMOVE_TERRAFORM_STAGE_FILES_CONFIRMATION + # Mock different upgrade steps prompt answers - if ( - prompt - == "Have you deleted the Argo Workflows CRDs and service accounts? [y/N] " - ): - return "y" + if prompt == "Have you deleted the Argo Workflows CRDs and service accounts?": + return True elif ( prompt == "\nDo you want Nebari to update the kube-prometheus-stack CRDs and delete the prometheus-node-exporter for you? If not, you'll have to do it manually." ): - return "N" + return False elif ( prompt == "Have you backed up your custom dashboards (if necessary), deleted the prometheus-node-exporter daemonset and updated the kube-prometheus-stack CRDs?" ): - return "y" + return True elif ( prompt == "[bold]Would you like Nebari to assign the corresponding role/scopes to all of your current groups automatically?[/bold]" ): - return "N" + return False + elif prompt == TERRAFORM_REMOVE_TERRAFORM_STAGE_FILES_CONFIRMATION: + return attempt_fixes # All other prompts will be answered with "y" else: - return "y" + return True + + monkeypatch.setattr(Confirm, "ask", mock_input) + monkeypatch.setattr(Prompt, "ask", lambda x: "") + + from kubernetes import config as _kube_config + from kubernetes.client import ApiextensionsV1Api as _ApiextensionsV1Api + from kubernetes.client import AppsV1Api as _AppsV1Api + from kubernetes.client import CoreV1Api as _CoreV1Api + from kubernetes.client import V1Status as _V1Status + + def monkey_patch_delete_crd(*args, **kwargs): + return _V1Status(code=200) - monkeypatch.setattr(Prompt, "ask", mock_input) + def monkey_patch_delete_namespaced_sa(*args, **kwargs): + return _V1Status(code=200) + + def monkey_patch_list_namespaced_daemon_set(*args, **kwargs): + class MonkeypatchApiResponse: + items = False + + return MonkeypatchApiResponse + + monkeypatch.setattr( + _kube_config, + "load_kube_config", + lambda *args, **kwargs: None, + ) + monkeypatch.setattr( + _kube_config, + "list_kube_config_contexts", + lambda *args, **kwargs: [None, {"context": {"cluster": "test"}}], + ) + monkeypatch.setattr( + _ApiextensionsV1Api, + "delete_custom_resource_definition", + monkey_patch_delete_crd, + ) + monkeypatch.setattr( + _CoreV1Api, + "delete_namespaced_service_account", + monkey_patch_delete_namespaced_sa, + ) + monkeypatch.setattr( + _ApiextensionsV1Api, + "read_custom_resource_definition", + lambda *args, **kwargs: True, + ) + monkeypatch.setattr( + _ApiextensionsV1Api, + "patch_custom_resource_definition", + lambda *args, **kwargs: True, + ) + monkeypatch.setattr( + _AppsV1Api, + "list_namespaced_daemon_set", + monkey_patch_list_namespaced_daemon_set, + ) + + from _nebari import upgrade as _upgrade + + def monkey_patch_get_keycloak_admin(*args, **kwargs): + return MockKeycloakAdmin() + + monkeypatch.setattr( + _upgrade, + "get_keycloak_admin", + monkey_patch_get_keycloak_admin, + ) old_qhub_config_path = Path(__file__).parent / old_qhub_config_path_str diff --git a/tests/tests_unit/test_utils.py b/tests/tests_unit/test_utils.py index 678cd1f230..88b911ff60 100644 --- a/tests/tests_unit/test_utils.py +++ b/tests/tests_unit/test_utils.py @@ -1,6 +1,6 @@ import pytest -from _nebari.utils import JsonDiff, JsonDiffEnum, byte_unit_conversion +from _nebari.utils import JsonDiff, JsonDiffEnum, byte_unit_conversion, deep_merge @pytest.mark.parametrize( @@ -64,3 +64,75 @@ def test_JsonDiff_modified(): diff = JsonDiff(obj1, obj2) modifieds = diff.modified() assert sorted(modifieds) == sorted([(["b", "!"], 2, 3), (["+"], 4, 5)]) + + +def test_deep_merge_order_preservation_dict(): + value_1 = { + "a": [1, 2], + "b": {"c": 1, "z": [5, 6]}, + "e": {"f": {"g": {}}}, + "m": 1, + } + + value_2 = { + "a": [3, 4], + "b": {"d": 2, "z": [7]}, + "e": {"f": {"h": 1}}, + "m": [1], + } + + expected_result = { + "a": [1, 2, 3, 4], + "b": {"c": 1, "z": [5, 6, 7], "d": 2}, + "e": {"f": {"g": {}, "h": 1}}, + "m": 1, + } + + result = deep_merge(value_1, value_2) + assert result == expected_result + assert list(result.keys()) == list(expected_result.keys()) + assert list(result["b"].keys()) == list(expected_result["b"].keys()) + assert list(result["e"]["f"].keys()) == list(expected_result["e"]["f"].keys()) + + +def test_deep_merge_order_preservation_list(): + value_1 = { + "a": [1, 2], + "b": {"c": 1, "z": [5, 6]}, + } + + value_2 = { + "a": [3, 4], + "b": {"d": 2, "z": [7]}, + } + + expected_result = { + "a": [1, 2, 3, 4], + "b": {"c": 1, "z": [5, 6, 7], "d": 2}, + } + + result = deep_merge(value_1, value_2) + assert result == expected_result + assert result["a"] == expected_result["a"] + assert result["b"]["z"] == expected_result["b"]["z"] + + +def test_deep_merge_single_dict(): + value_1 = { + "a": [1, 2], + "b": {"c": 1, "z": [5, 6]}, + } + + expected_result = value_1 + + result = deep_merge(value_1) + assert result == expected_result + assert list(result.keys()) == list(expected_result.keys()) + assert list(result["b"].keys()) == list(expected_result["b"].keys()) + + +def test_deep_merge_empty(): + expected_result = {} + + result = deep_merge() + assert result == expected_result