#27 - Remove offline artifact mode from documentation and code.

edenlabllc · Sep 2, 2024 · 7553503 · 7553503
1 parent b988aa6
commit 7553503
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -190,8 +190,8 @@ Among the providers are:
 - **Guidelines for contributors:** Create comprehensive guidelines for contributors, including instructions for creating pull requests (PRs).
 - **Integration with Helmfile [vals](https://github.com/helmfile/vals)**: Integrate RMK with the **vals** tool for enhanced values and secret management.
 - **Major update of the AWS [EKS](https://aws.amazon.com/eks/) cluster provider:** Update the AWS EKS cluster provider to the latest versions to utilize all the supported features of the [Terraform](https://www.terraform.io/) CLI and modules.
-- **Implementation of additional RMK cluster providers:** Implement support for additional cluster providers for popular Kubernetes services such as [GKE](https://cloud.google.com/kubernetes-engine), [AKS](https://azure.microsoft.com/en-us/products/kubernetes-service/), etc.
-- **Offline artifact mode:** Implement the **offline** artifact mode to install artifacts in fully isolated offline environments.
+- **Implementation of additional Terraform-based RMK cluster providers:** Implement support for additional cluster providers for popular Kubernetes services such as [GKE](https://cloud.google.com/kubernetes-engine), [AKS](https://azure.microsoft.com/en-us/products/kubernetes-service/), etc. using [Terraform](https://www.terraform.io/).
+- **Implementation of additional Kubernetes Cluster API-based RMK cluster providers:** Implement support for additional cluster providers for popular Kubernetes services such as [GKE](https://cloud.google.com/kubernetes-engine), [AKS](https://azure.microsoft.com/en-us/products/kubernetes-service/), etc. using [Kubernetes Cluster API](https://cluster-api.sigs.k8s.io/introduction).
 - **Web documentation generator:** Add an HTML documentation generator based on the **.md** files.
 - **Automatic testing of RMK during the CI/CD pipeline:** Ensure that changes to the RMK codebase do not introduce errors or regressions during the CI/CD.
 

diff --git a/commands/flags.go b/commands/flags.go
@@ -13,7 +13,7 @@ func flagsConfig() []cli.Flag {
 		altsrc.NewStringFlag(
 			&cli.StringFlag{
 				Name:    "artifact-mode",
-				Usage:   "choice of artifact usage model, available: none, online, offline",
+				Usage:   "choice of artifact usage model, available: none, online",
 				Aliases: []string{"am"},
 				EnvVars: []string{"RMK_ARTIFACT_MODE"},
 				Value:   system.ArtifactModeDefault,

diff --git a/commands/project_generation_category.go b/commands/project_generation_category.go
@@ -201,7 +201,7 @@ develop ------> staging ------> production
   release/vN.N.N-rc  release/vN.N.N
 ` + "```" + `
 
-### Generating the Project Structure
+### Generating project structure
 
 > Note: The generated project structure using the RMK tools is mandatory and is required for the interaction of the RMK with the code base. 
 > All generated files have example content and can be supplemented according to project requirements.

diff --git a/docs/README.md b/docs/README.md
@@ -165,8 +165,7 @@ rmk update --version vX.X.X
   to update release and service version declarations, automatically commit the changes to Git.
 - **[Project structure generation:](configuration/project-management/preparation-of-project-repository.md#automatic-generation-of-the-project-structure-from-scratch)** Generate a complete Kubernetes-based project structure from scratch using RMK, following the best practices.
 - **[Documentation generation:](commands.md#doc)** Generate the full command documentation in the Markdown format with one click.
-- **[Support for different types of code sources:](configuration/configuration-management.md#use-upstream-artifact-for-the-downstream-projects-repository)** Use Git when the _artifact-mode_ is _none_, S3 when the _artifact-mode_ is _online_, 
-  switch to fully offline installations when the _artifact-mode_ is _offline_.
+- **[Support for different types of code sources:](configuration/configuration-management.md#use-upstream-artifact-for-the-downstream-projects-repository)** Use Git when the _artifact-mode_ is _none_, S3 when the _artifact-mode_ is _online_. 
 
 ## Supported Kubernetes providers
 
@@ -191,7 +190,6 @@ Among the providers are:
 - **Integration with Helmfile [vals](https://github.com/helmfile/vals)**: Integrate RMK with the **vals** tool for enhanced values and secret management.
 - **Major update of the AWS [EKS](https://aws.amazon.com/eks/) cluster provider:** Update the AWS EKS cluster provider to the latest versions to utilize all the supported features of the [Terraform](https://www.terraform.io/) CLI and modules.
 - **Implementation of additional RMK cluster providers:** Implement support for additional cluster providers for popular Kubernetes services such as [GKE](https://cloud.google.com/kubernetes-engine), [AKS](https://azure.microsoft.com/en-us/products/kubernetes-service/), etc.
-- **Offline artifact mode:** Implement the **offline** artifact mode to install artifacts in fully isolated offline environments.
 - **Web documentation generator:** Add an HTML documentation generator based on the **.md** files.
 - **Automatic testing of RMK during the CI/CD pipeline:** Ensure that changes to the RMK codebase do not introduce errors or regressions during the CI/CD.
 

diff --git a/docs/commands.md b/docs/commands.md
@@ -144,7 +144,7 @@ Configuration management
 
 Initialize configuration for current tenant and selected environment
 
-**--artifact-mode, --am**="": choice of artifact usage model, available: none, online, offline (default: "none")
+**--artifact-mode, --am**="": choice of artifact usage model, available: none, online (default: "none")
 
 **--aws-ecr-host, --aeh**="": AWS ECR host (default: "288509344804.dkr.ecr.eu-north-1.amazonaws.com")
 
@@ -154,7 +154,7 @@ Initialize configuration for current tenant and selected environment
 
 **--aws-reconfigure, -r**: force AWS profile creation
 
-**--aws-reconfigure-artifact-license, -l**: force AWS profile creation for artifact license, used only if RMK config option artifact-mode has values: online, offline
+**--aws-reconfigure-artifact-license, -l**: force AWS profile creation for artifact license, used only if RMK config option artifact-mode has the values: online
 
 **--cloudflare-token, --cft**="": Cloudflare API token for provision NS records
 

diff --git a/docs/configuration/configuration-management.md b/docs/configuration/configuration-management.md
@@ -129,7 +129,7 @@ project:
 Set the `version` field to the version of the upstream project for the current project. For example:
 
 ```shell
-# artifact usage modes: none|online|offline (default: "none")
+# artifact usage modes: none|online (default: "none")
 rmk config init --artifact-mode=online
 ```
 
@@ -140,7 +140,6 @@ rmk config init --artifact-mode=online
 > - `online`: Switches RMK to work with artifacts. In this mode, RMK will not use any credentials for GitHub 
 >   (e.g., personal access tokens), but will request additional license AWS credentials to download and unpack 
 >   the artifact from a repository like AWS S3.
-> The `offline` mode is currently unsupported and will be implemented in future releases.
 
 To change the "license" AWS credentials when in the online artifact mode, use the following command: