Merge pull request #22 from edenlabllc/release/v0.42.4

Release/v0.42.4

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/issue.yml

@@ -0,0 +1,64 @@
+name: Issue
+description: Describe an issue.
+labels: [enhancement]
+projects:
+  - edenlabllc/43
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this issue! Please fill the form below.
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Describe your issue here.
+    validations:
+      required: true
+
+  - type: textarea
+    id: steps-to-reproduce
+    attributes:
+      label: Steps to reproduce
+      description: Tell us how to reproduce this issue.
+    validations:
+      required: false
+
+  - type: textarea
+    id: expected-behaviour
+    attributes:
+      label: Expected behaviour
+      description: Tell us what should happen.
+    validations:
+      required: false
+
+  - type: textarea
+    id: actual-behaviour
+    attributes:
+      label: Actual behaviour
+      description: Tell us what happens instead.
+    validations:
+      required: false
+
+  - type: textarea
+    id: environment-info
+    attributes:
+      label: Environment info
+      description: Specify information about your environment.
+      value: |
+        RMK: 
+        OS: 
+        Shell: 
+        Terminal:
+    validations:
+      required: false
+
+  - type: checkboxes
+    id: code-of-conduct
+    attributes:
+      label: Agree to the Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/edenlabllc/rmk/blob/master/docs/CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

README.md

@@ -10,6 +10,7 @@ Command line tool for reduced management and provisioning of Kubernetes clusters
   * [Overview](#overview)
     * [Advantages](#advantages)
     * [Edenlab LLC use cases](#edenlab-llc-use-cases)
+      * [Related OSS repositories](#related-oss-repositories)
   * [Requirements](#requirements)
   * [Quickstart](docs/quickstart.md)
   * [Installation](#installation)
@@ -92,6 +93,13 @@ The examples of Kubernetes providers, to which Kodjin has been installed, are:
 - on-premise installations deployed using [Ansible Kubespray](https://github.com/kubernetes-sigs/kubespray)
 - single-machine [K3D](https://k3d.io/) clusters
 
+#### Related OSS repositories
+
+- [AWS cluster provider for RMK](https://github.com/edenlabllc/aws.provisioner.infra)
+- [Azure cluster provider for RMK](https://github.com/edenlabllc/azure.provisioner.infra)
+- [K3D cluster provider for RMK](https://github.com/edenlabllc/k3d.provisioner.infra)
+- [Helmfile hooks](https://github.com/edenlabllc/helmfile.hooks.infra)
+
 ## Requirements
 
 Currently, RMK only supports Unix-like operating systems (OS):

docs/CODE_OF_CONDUCT.md

@@ -0,0 +1,129 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and maintainers pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Maintainers are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the maintainers responsible for enforcement and specified in 
+[CODEOWNERS](https://github.com/edenlabllc/rmk/blob/master/docs/CODEOWNERS).
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+All maintainers are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Maintainers will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from maintainers, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

docs/CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Contributing Guidelines
+
+## Reporting Issues
+
+Before creating a new issue, please check first if a similar issue [already exists](https://github.com/edenlabllc/rmk/issues?state=open) or was [recently closed](https://github.com/edenlabllc/rmk/issues?direction=desc&page=1&sort=updated&state=closed).
+
+## Contributing Code
+
+Currently, we do not accept pull requests. Please report an issue instead.
+
+### Code Review
+
+Everyone is invited to review and comment on pull requests.

docs/SECURITY.md

@@ -0,0 +1,31 @@
+# Security Policy
+
+## Supported Versions
+
+We release patches for security vulnerabilities for latest software versions.
+
+## Reporting a Vulnerability
+
+The security team and community take all security vulnerabilities seriously. 
+Thank you for improving the security of our open source software. 
+We appreciate your efforts and responsible disclosure and will make every effort to acknowledge your contributions.
+
+Report security vulnerabilities by notifying the team specified in [CODEOWNERS](https://github.com/edenlabllc/rmk/blob/master/docs/CODEOWNERS).
+
+The lead maintainers will acknowledge your email and send a more detailed response indicating the next steps in handling your report. 
+After the initial reply to your report, the security team will endeavor to keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance.
+
+Report security vulnerabilities in third-party modules to the person or team maintaining the module.
+
+## Disclosure Policy
+
+When the security team receives a security bug report, they will assign it to a primary handler. 
+This person will coordinate the fix and release process, involving the following steps:
+
+- Confirm the problem and determine the affected versions.
+- Audit code to find any potential similar problems.
+- Prepare fixes for all releases still under maintenance. These fixes will be released as fast as possible.
+
+## Preferred Languages
+
+We prefer all communications to be in English.

docs/configuration/cluster-management/cluster-management.md

@@ -100,7 +100,7 @@ The core configurations are divided into two types:
   ```terraform
   # k8s user list
   k8s_master_usernames = [] # list of AWS IAM users for K8S cluster management
-  k8s_cluster_version  = "1.27" # current version K8S(EKS) control plane
+  k8s_cluster_version  = "1.27" # current version of K8S (EKS) control plane
   # ...
   ```
 
@@ -127,13 +127,17 @@ The core configurations are divided into two types:
 
   > Each AWS region requires its own AMI image ID. To determine the appropriate ID for a specific region, run the following command:
   > ```shell
-  > AWS_PROFILE=$(rmk --lf=json config view | jq '.config.Profile' -r) \
-  >   aws ssm get-parameter \
-  >   --name /aws/service/eks/optimized-ami/<EKS_control_plane_version>/amazon-linux-2/recommended/image_id \
-  >   --region <aws_region> \
-  >   --query "Parameter.Value" \
-  >   --output text
+  > AWS_PROFILE=$(rmk --lf=json config view | yq '.config.Profile') \
+  > AWS_CONFIG_FILE="${HOME}/.aws/config_$(rmk --lf=json config view | yq '.config.Profile')" \
+  > AWS_SHARED_CREDENTIALS_FILE="${HOME}/.aws/credentials_$(rmk --lf=json config view | yq '.config.Profile')" \
+  > AWS_PAGER= \
+  > aws ssm get-parameter \
+  >   --name /aws/service/eks/optimized-ami/<eks_control_plane_version>/amazon-linux-2/recommended/image_id \
+  >   --region "$(rmk --lf=json config view | yq '.config.Region')" \
+  >   --output text \
+  >   --query Parameter.Value
   > ```
+  > > Replace `<eks_control_plane_version>` with a correct version.
 
 Full list of input Terraform variables: `.PROJECT/inventory/clusters/aws.provisioner.infra-<version>/terraform/variables.tf`
 

docs/release-notes.md

@@ -1 +1,3 @@
-- #12 - Fixed a "panic" log output that occurred when the Kubernetes context was not created before.
+- #18 - Added the files recommended by the GitHub's community profiles.
+- #18 - Added a list of related OSS repositories.
+- #18 - Improved the cluster management instructions regarding recommended AMI images.