Skip to content

Commit

Permalink
#27 - Fix relative links in MD files. Uncommented quickstart links. C…
Browse files Browse the repository at this point in the history
…orrect navigation titles.
  • Loading branch information
anovikov-el committed Aug 20, 2024
1 parent 8d0ddd6 commit 339dd60
Show file tree
Hide file tree
Showing 8 changed files with 27 additions and 28 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# RMK CLI - Reduced Management for Kubernetes

[![Release](https://img.shields.io/github/v/release/edenlabllc/rmk.svg?style=for-the-badge)](https://github.com/edenlabllc/rmk/releases/latest)
[![Software License](https://img.shields.io/github/license/edenlabllc/rmk.svg?style=for-the-badge)](LICENSE)
[![Software License](https://img.shields.io/github/license/edenlabllc/rmk.svg?style=for-the-badge)](https://github.com/edenlabllc/rmk/blob/master/LICENSE)
[![Powered By: Edenlab](https://img.shields.io/badge/powered%20by-edenlab-8A2BE2.svg?style=for-the-badge)](https://edenlab.io)

Command line tool for reduced management and provisioning of Kubernetes clusters and environments, Helm secrets and releases.
Expand All @@ -18,7 +18,7 @@ Command line tool for reduced management and provisioning of Kubernetes clusters
* [General update process](#general-update-process)
* [Update to specific version](#update-to-specific-version)
* Configuration
* [RMK configuration management](docs/configuration/rmk-configuration-management.md)
* [Configuration management](docs/configuration/configuration-management.md)
* Project management
* [Requirement for project repository](docs/configuration/project-management/requirement-for-project-repository.md)
* [Preparation of project repository](docs/configuration/project-management/preparation-of-project-repository.md)
Expand Down Expand Up @@ -154,13 +154,13 @@ rmk update --version vX.X.X
- **[Time-proven project structure:](docs/configuration/project-management/preparation-of-project-repository.md)** Define the project structure using the [GitLabFlow](https://about.gitlab.com/topics/version-control/what-is-gitlab-flow/) methodology.
- **[Hierarchies between different projects:](docs/configuration/project-management/dependencies-management-and-project-inheritance.md)** Define upstream-downstream relationships between sibling projects to reuse releases and services across different installations.
- **[Batch secret management:](docs/configuration/secrets-management/secrets-management.md#generating-all-secrets-from-scratch-in-a-batch-manner-using-the-rmk-secrets-manager)** Template, generate, and encode project secrets for all environments in a batch manner.
- **[Clone environments with one click:](docs/configuration/rmk-configuration-management.md#initialization-of-rmk-configuration-for-feature-or-release-clusters)** Use the special `--config-from-environment` (`--cfe`) flag to create an environment based on an existing one.
- **[Automatic detection of Multi-Factor Authentication](docs/configuration/rmk-configuration-management.md#support-for-multi-factor-authentication-mfa) ([MFA](https://en.wikipedia.org/wiki/Multi-factor_authentication)):** Automatically detect and use an MFA device if one is defined by an [IAM](https://aws.amazon.com/iam/) user (must be supported by the cluster provider, e.g., [AWS](https://aws.amazon.com/)).
- **[Clone environments with one click:](docs/configuration/configuration-management.md#initialization-of-rmk-configuration-for-feature-or-release-clusters)** Use the special `--config-from-environment` (`--cfe`) flag to create an environment based on an existing one.
- **[Automatic detection of Multi-Factor Authentication](docs/configuration/configuration-management.md#support-for-multi-factor-authentication-mfa) ([MFA](https://en.wikipedia.org/wiki/Multi-factor_authentication)):** Automatically detect and use an MFA device if one is defined by an [IAM](https://aws.amazon.com/iam/) user (must be supported by the cluster provider, e.g., [AWS](https://aws.amazon.com/)).
- **[Push-based release and downstream project updates:](docs/configuration/release-management/release-management.md#release-update-and-integration-into-the-cd-pipeline)** Easily integrate with CI/CD solutions via webhooks or workflow dispatch events
to update release and service version declarations, automatically commit the changes to Git.
- **[Project structure generation:](docs/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:](docs/commands.md#doc)** Generate the full command documentation in the Markdown format with one click.
- **[Support for different types of code sources:](docs/configuration/rmk-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_,
- **[Support for different types of code sources:](docs/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_.

## Supported Kubernetes providers
Expand Down Expand Up @@ -194,10 +194,10 @@ Check the [issues](https://github.com/edenlabllc/rmk/issues) for more informatio

## License

RMK is open source software (OSS) licensed under the [Apache 2.0 License](LICENSE).
RMK is open source software (OSS) licensed under the [Apache 2.0 License](https://github.com/edenlabllc/rmk/blob/master/LICENSE).

## Code of Conduct

This project adheres to the Contributor Covenant [Сode of Сonduct](https://github.com/edenlabllc/rmk/blob/develop/docs/CODE_OF_CONDUCT.md).
This project adheres to the Contributor Covenant [Сode of Сonduct](https://github.com/edenlabllc/rmk/blob/master/docs/CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code.
Please refer to our [Contributing Guidelines](https://github.com/edenlabllc/rmk/blob/develop/docs/CONTRIBUTING.md) for further information.
Please refer to our [Contributing Guidelines](https://github.com/edenlabllc/rmk/blob/master/docs/CONTRIBUTING.md) for further information.
6 changes: 2 additions & 4 deletions docs/.pages
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
nav:
- README.md
- Overview: README.md
- quickstart.md
- configuration
- commands.md
- Commands: commands.md
- development-and-release-flow.md
- release-notes.md
- release-notes.md
collapse: false
16 changes: 8 additions & 8 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# RMK CLI - Reduced Management for Kubernetes

[![Release](https://img.shields.io/github/v/release/edenlabllc/rmk.svg?style=for-the-badge)](https://github.com/edenlabllc/rmk/releases/latest)
[![Software License](https://img.shields.io/github/license/edenlabllc/rmk.svg?style=for-the-badge)](LICENSE)
[![Software License](https://img.shields.io/github/license/edenlabllc/rmk.svg?style=for-the-badge)](https://github.com/edenlabllc/rmk/blob/master/LICENSE)
[![Powered By: Edenlab](https://img.shields.io/badge/powered%20by-edenlab-8A2BE2.svg?style=for-the-badge)](https://edenlab.io)

Command line tool for reduced management and provisioning of Kubernetes clusters and environments, Helm secrets and releases.
Expand All @@ -18,7 +18,7 @@ Command line tool for reduced management and provisioning of Kubernetes clusters
* [General update process](#general-update-process)
* [Update to specific version](#update-to-specific-version)
* Configuration
* [RMK configuration management](configuration/rmk-configuration-management.md)
* [Configuration management](configuration/configuration-management.md)
* Project management
* [Requirement for project repository](configuration/project-management/requirement-for-project-repository.md)
* [Preparation of project repository](configuration/project-management/preparation-of-project-repository.md)
Expand Down Expand Up @@ -154,13 +154,13 @@ rmk update --version vX.X.X
- **[Time-proven project structure:](configuration/project-management/preparation-of-project-repository.md)** Define the project structure using the [GitLabFlow](https://about.gitlab.com/topics/version-control/what-is-gitlab-flow/) methodology.
- **[Hierarchies between different projects:](configuration/project-management/dependencies-management-and-project-inheritance.md)** Define upstream-downstream relationships between sibling projects to reuse releases and services across different installations.
- **[Batch secret management:](configuration/secrets-management/secrets-management.md#generating-all-secrets-from-scratch-in-a-batch-manner-using-the-rmk-secrets-manager)** Template, generate, and encode project secrets for all environments in a batch manner.
- **[Clone environments with one click:](configuration/rmk-configuration-management.md#initialization-of-rmk-configuration-for-feature-or-release-clusters)** Use the special `--config-from-environment` (`--cfe`) flag to create an environment based on an existing one.
- **[Automatic detection of Multi-Factor Authentication](configuration/rmk-configuration-management.md#support-for-multi-factor-authentication-mfa) ([MFA](https://en.wikipedia.org/wiki/Multi-factor_authentication)):** Automatically detect and use an MFA device if one is defined by an [IAM](https://aws.amazon.com/iam/) user (must be supported by the cluster provider, e.g., [AWS](https://aws.amazon.com/)).
- **[Clone environments with one click:](configuration/configuration-management.md#initialization-of-rmk-configuration-for-feature-or-release-clusters)** Use the special `--config-from-environment` (`--cfe`) flag to create an environment based on an existing one.
- **[Automatic detection of Multi-Factor Authentication](configuration/configuration-management.md#support-for-multi-factor-authentication-mfa) ([MFA](https://en.wikipedia.org/wiki/Multi-factor_authentication)):** Automatically detect and use an MFA device if one is defined by an [IAM](https://aws.amazon.com/iam/) user (must be supported by the cluster provider, e.g., [AWS](https://aws.amazon.com/)).
- **[Push-based release and downstream project updates:](configuration/release-management/release-management.md#release-update-and-integration-into-the-cd-pipeline)** Easily integrate with CI/CD solutions via webhooks or workflow dispatch events
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/rmk-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_,
- **[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_.

## Supported Kubernetes providers
Expand Down Expand Up @@ -194,10 +194,10 @@ Check the [issues](https://github.com/edenlabllc/rmk/issues) for more informatio

## License

RMK is open source software (OSS) licensed under the [Apache 2.0 License](../LICENSE).
RMK is open source software (OSS) licensed under the [Apache 2.0 License](https://github.com/edenlabllc/rmk/blob/master/LICENSE).

## Code of Conduct

This project adheres to the Contributor Covenant [Сode of Сonduct](CODE_OF_CONDUCT.md).
This project adheres to the Contributor Covenant [Сode of Сonduct](https://github.com/edenlabllc/rmk/blob/master/docs/CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code.
Please refer to our [Contributing Guidelines](CONTRIBUTING.md) for further information.
Please refer to our [Contributing Guidelines](https://github.com/edenlabllc/rmk/blob/master/docs/CONTRIBUTING.md) for further information.
4 changes: 2 additions & 2 deletions docs/configuration/cluster-management/cluster-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Switching to an existing Kubernetes cluster depends on how it has been provision
Checkout to the branch from which the K8S cluster was previously created.
An [initialization](../rmk-configuration-management.md#initialization-of-rmk-configuration) might be required,
An [initialization](../configuration-management.md#initialization-of-rmk-configuration) might be required,
if the RMK configuration for this cluster has not been created before:
```shell
Expand Down Expand Up @@ -167,7 +167,7 @@ The CLI will create a cluster according to the declarative instruction for K3D:
> Prerequisites:
> 1. Create a separate feature branch: `feature/<issue_key>-<issue_number>-<issue_description>`.
> 2. [Initialize configuration](../rmk-configuration-management.md#initialization-of-rmk-configuration) for this branch with the `localhost` root domain name:
> 2. [Initialize configuration](../configuration-management.md#initialization-of-rmk-configuration) for this branch with the `localhost` root domain name:
> ```shell
> rmk config init --root-domain=localhost
> ```
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# RMK configuration management
# Configuration management

To start working with Kubernetes clusters, RMK needs to initialize the configuration for the current environment.
At the time of configuration initialization launch, RMK prepares
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
> - Clone the project repository. For example: **project.bootstrap.infra** OR `git init && git remote add && git commit -m "init commit"`
> - Checkout the needed branch. For example: `develop|staging|production`.
> - Make sure there is a file in the root of the repository named [project.yaml](#projectyaml), which contains the project configuration.
> - [Initialize the configuration](../rmk-configuration-management.md#initialization-of-rmk-configuration).
> - [Initialize the configuration](../configuration-management.md#initialization-of-rmk-configuration).
## Automatic generation of the project structure from scratch

Expand Down
8 changes: 4 additions & 4 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ create a local cluster based on `K3D`, deploy your first application ([Nginx](ht
> - An active AWS user with access keys and the `AdministratorAccess` permissions.
> - A prepared [project repository](configuration/project-management/preparation-of-project-repository.md#preparation-of-the-project-repository)
[//]: # (> - Installed [RMK]&#40;../README.md#installation&#41;)
[//]: # (> - The fulfilled [requirements]&#40;../README.md#requirements&#41; for proper RMK operation.)
> - Installed [RMK](README.md#installation)
> - The fulfilled [requirements](README.md#requirements) for proper RMK operation.
0. Create a [project.yaml](configuration/project-management/preparation-of-project-repository.md#projectyaml)
file in the root of the project repository with the following content:
Expand Down Expand Up @@ -85,7 +85,7 @@ inventory:
rename: true
```
1. Run the [RMK configuration initialization](configuration/rmk-configuration-management.md#initialization-of-rmk-configuration) command for the repository:
1. Run the [RMK configuration initialization](configuration/configuration-management.md#initialization-of-rmk-configuration) command for the repository:
```shell
rmk config init --root-domain=localhost --github-token=<github_personal_access_token>
Expand All @@ -104,7 +104,7 @@ inventory:

3. Create a local K3D cluster:

[//]: # ( > Before running this step, ensure that Docker is installed in the system according to the [requirements]&#40;../README.md#requirements&#41;.)
> Before running this step, ensure that Docker is installed in the system according to the [requirements](README.md#requirements).
```shell
rmk cluster k3d create
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ plugins:
extra:
version:
provider: mike
default: latest

# Other Settings
strict: true # halt processing when a warning is raised

0 comments on commit 339dd60

Please sign in to comment.