Skip to content

Commit

Permalink
Apply fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
ademariag committed Sep 1, 2024
1 parent 0f2f7b6 commit 205b77e
Show file tree
Hide file tree
Showing 287 changed files with 434 additions and 588 deletions.
20 changes: 10 additions & 10 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ body:
# information
- type: markdown
attributes:
value: |
value: |
Thanks for taking the time to fill out this bug report!
*Note:* Please search to see if an issue already exists for the bug you encountered.
# bug description
Expand All @@ -27,10 +27,10 @@ body:
placeholder: Tell us what steps you did to encounter the bug!
render: bash
value: |
1.
2.
3.
4.
1.
2.
3.
4.
validations:
required: true
# expected behavior
Expand All @@ -47,7 +47,7 @@ body:
id: additional-context
attributes:
label: Additional context
description: |
description: |
Add any other context about the problem here.
If applicable, you can add screenshots to help explain your problem.
placeholder: Anything that might help us understanding your problem...
Expand All @@ -62,7 +62,7 @@ body:
attributes:
label: Version (kapitan)
description: |
Which version of kapitan are you running?
Which version of kapitan are you running?
If you are using an older version of kapitan, please try it against the master branch or the latest stable version.
options:
- v0.31.0 (stable)
Expand All @@ -76,11 +76,11 @@ body:
attributes:
label: Version (kapitan)
description: |
Which version of python are you using? Kapitan officially supports only version 3.10 and 3.11
Which version of python are you using? Kapitan officially supports only version 3.10 and 3.11
If you are using an older version of python, please check if the bug still exists with a newer (supported) version.
options:
- "3.11"
- "3.10"
- "3.10"
- I use kapitan directly (pip, docker)
multiple: true
validations:
Expand All @@ -107,7 +107,7 @@ body:
id: logs
attributes:
label: Relevant log output
description: |
description: |
Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
Use the `--verbose` flag to see all the logs.
render: bash
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ contact_links:
- name: '💬 Join us on Slack'
url: https://kubernetes.slack.com/archives/C981W2HD3
about: |
Join our Slack channel to connect with our community, ask questions, and stay updated on project developments.
Join our Slack channel to connect with our community, ask questions, and stay updated on project developments.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ body:
# information
- type: markdown
attributes:
value: |
value: |
Thanks for taking the time to give us feedback!
# feature description
- type: textarea
id: documentation-issue-description
attributes:
label: Description of the documentation issue
description: |
A clear and concise description of what the issue with documentation is.
A clear and concise description of what the issue with documentation is.
Please make proposals, how it could be done better.
placeholder: Tell us what you want to see in the project!
validations:
Expand All @@ -24,6 +24,6 @@ body:
id: additional-context
attributes:
label: Additional context
description: |
description: |
Add any other context about the feature here.
placeholder: Anything that might help us understanding your documentation issue...
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ body:
# information
- type: markdown
attributes:
value: |
value: |
Thanks for taking the time to fill out this feature request!
# feature description
- type: textarea
id: feature-description
attributes:
label: Description of the feature
description: |
A clear and concise description of what the feature request is.
A clear and concise description of what the feature request is.
Please make proposals, how you would use this feature (syntax).
placeholder: Tell us what you want to see in the project!
validations:
Expand All @@ -24,6 +24,6 @@ body:
id: additional-context
attributes:
label: Additional context
description: |
description: |
Add any other context about the feature here.
placeholder: Anything that might help us understanding your feature request...
2 changes: 1 addition & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ updates:
schedule:
interval: "daily"
labels:
- "github-actions"
- "github-actions"
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ Fixes #
## Docs and Tests

* [ ] Tests added
* [ ] Updated documentation
* [ ] Updated documentation
2 changes: 1 addition & 1 deletion .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ on:
- 'docs/**'
- '.github/workflows/documentation.yml'
- 'mkdocs.yml'
- 'CNAME'
- 'CNAME'
push:
branches:
- master
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/housekeeping.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ jobs:
with:
stale-issue-message: |
This issue is stale because it has been open for 1 year with no activity.
Remove the stale label or comment if this issue is still relevant for you.
Remove the stale label or comment if this issue is still relevant for you.
If not, please close it yourself.
days-before-issue-stale: 365
day-before-pr-stale: -1
days-before-close: -1
days-before-pr-close: -1
days-before-pr-close: -1
4 changes: 2 additions & 2 deletions .github/workflows/pex-build-upload.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
steps:
- uses: actions/checkout@v4
- name: Install poetry
run: |-
run: |-
pipx install poetry
pipx inject poetry poetry-plugin-export --force
- name: Set up Python
Expand Down Expand Up @@ -47,7 +47,7 @@ jobs:
--python=python3.12 \
-m kapitan \
-o dist/kapitan.linux-x86_64.pex
dist/kapitan.linux-x86_64.pex --help
dist/kapitan.linux-x86_64.pex --help
- name: Add linux-x86_64 pex to assets
uses: softprops/action-gh-release@v2
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/python-pip-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ name: Upload Python Package
concurrency:
group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
cancel-in-progress: true

on:
workflow_dispatch:
release:
Expand Down
16 changes: 8 additions & 8 deletions .github/workflows/test-build-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ concurrency:
group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
cancel-in-progress: true

on:
on:
push:
branches:
- master
Expand Down Expand Up @@ -37,7 +37,7 @@ jobs:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
- uses: psf/black@main

test:
name: python ${{ matrix.python-version }} tests
runs-on: ubuntu-latest
Expand All @@ -60,7 +60,7 @@ jobs:
python-version: ${{ matrix.python-version }}
- name: Install libraries dependencies
run: |
poetry install --no-root
poetry install --no-root
- name: Install testing dependencies (Helm)
run: |
sudo apt-get -qq update
Expand Down Expand Up @@ -92,7 +92,7 @@ jobs:
uses: actions/checkout@v4
with:
submodules: recursive

# Setup QEMU and Buildx to build multi-platform image
# This was inspired by this example : https://docs.docker.com/build/ci/github-actions/examples/#multi-platform-images
- name: Set up QEMU
Expand All @@ -104,7 +104,7 @@ jobs:
- name: build Kapitan Image
uses: docker/build-push-action@v6
with:
push: False
push: False
platforms: ${{ matrix.platform }}
load: True
file: Dockerfile
Expand Down Expand Up @@ -134,7 +134,7 @@ jobs:
uses: actions/checkout@v4
with:
submodules: recursive

# Setup QEMU and Buildx to build multi-platform image
# This was inspired by this example : https://docs.docker.com/build/ci/github-actions/examples/#multi-platform-images
- name: Set up QEMU
Expand Down Expand Up @@ -223,7 +223,7 @@ jobs:
type=semver,pattern={{version}}
type=semver,pattern={{major}}.{{minor}}
type=semver,pattern={{major}}
- uses: int128/docker-manifest-create-action@v1
env:
DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME}}
Expand All @@ -233,4 +233,4 @@ jobs:
builder: buildx
suffixes: |
-linux-amd64
-linux-arm64
-linux-arm64
2 changes: 1 addition & 1 deletion .markdownlintignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
examples/
tests/
kapitan/
PULL_REQUEST_TEMPLATE.md
PULL_REQUEST_TEMPLATE.md
10 changes: 9 additions & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,12 @@ repos:
rev: 5.13.2
hooks:
- id: isort
args: [--profile, black]
args: [--profile, black]
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
hooks:
- id: trailing-whitespace
- id: check-docstring-first
- id: debug-statements
- id: end-of-file-fixer
- id: check-merge-conflict
2 changes: 1 addition & 1 deletion CNAME
Original file line number Diff line number Diff line change
@@ -1 +1 @@
kapitan.dev
kapitan.dev
2 changes: 1 addition & 1 deletion _config.yml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
markdown: kramdown
markdown: kramdown
2 changes: 1 addition & 1 deletion compiled/minikube-es/script.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ set -ex

compile_dir=$1

echo "This is going into a file" > "${compile_dir}/${FILE_NAME}"
echo "This is going into a file" > "${compile_dir}/${FILE_NAME}"
2 changes: 1 addition & 1 deletion docs/ADOPTERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ If you're using **Kapitan** in your organization, please let us know by adding t
- [![Ubisoft](adopters_logos/ubisoft.png){: style="height:100px"}](https://www.ubisoft.com/)
- [![VSHN AG](adopters_logos/vhsn.png){: style="height:100px"}](https://www.vshn.ch)
- [![Flower Labs](adopters_logos/flower.png){: style="height:100px"}](https://www.flower.ai)
</div>
</div>
2 changes: 1 addition & 1 deletion docs/CNAME
Original file line number Diff line number Diff line change
@@ -1 +1 @@
kapitan.dev
kapitan.dev
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
![GitHub Sponsors](https://img.shields.io/github/sponsors/kapicorp?style=for-the-badge)
![GitHub Stars](https://img.shields.io/github/stars/kapicorp/kapitan?style=for-the-badge)

**Kapitan** aims to be your *one-stop configuration management solution* to help you manage the ever growing complexity of your configurations by enabling **Platform Engineering** and **GitOps** workflows.
**Kapitan** aims to be your *one-stop configuration management solution* to help you manage the ever growing complexity of your configurations by enabling **Platform Engineering** and **GitOps** workflows.

It streamlines complex deployments across heterogeneous environments while providing a secure and adaptable framework for managing infrastructure configurations. **Kapitan**'s inventory-driven model, powerful templating capabilities, and native secret management tools offer granular control, fostering consistency, reducing errors, and safeguarding sensitive data.

Expand All @@ -12,7 +12,7 @@ Empower your team to make changes to your infrastructure whilst maintaining full
* :fontawesome-brands-slack: Join the community [`#kapitan`](https://kubernetes.slack.com/archives/C981W2HD3)
* :fontawesome-brands-github: Help us grow: [give us a star](https://github.com/kapicorp/kapitan/stargazers) or even better [sponsor our project](pages/contribute/sponsor/)

## [Why do I need **Kapitan**?](pages/blog/posts/2022-12-04.md#why-do-i-need-kapitan)
## [Why do I need **Kapitan**?](pages/blog/posts/2022-12-04.md#why-do-i-need-kapitan)

## [Video Tutorials to get started](https://www.youtube.com/@kapitandev)

Expand All @@ -28,4 +28,4 @@ Empower your team to make changes to your infrastructure whilst maintaining full
<iframe width="1024" height="576" src="https://www.youtube.com/embed/clPkDuC2bY4?si=GQwMGNpXuucUTwri" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

=== "Rawkode: Introduction to Kapitan"
<iframe width="1024" height="576" src="https://www.youtube.com/embed/8QZvgJi0vII?si=iqLZXv9VvoJD4hTT" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
<iframe width="1024" height="576" src="https://www.youtube.com/embed/8QZvgJi0vII?si=iqLZXv9VvoJD4hTT" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
4 changes: 2 additions & 2 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# :kapitan-logo: **Kapitan Overview**

## Setup your installation
## Setup your installation

Using our reference repositories you can easily get started with **Kapitan**

Expand Down Expand Up @@ -94,7 +94,7 @@ Compiled echo-server (0.14s)
kapitan -h
```

### Pip
### Pip

#### Install Python

Expand Down
2 changes: 1 addition & 1 deletion docs/images/logo.min.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/kap_proposals/kap_11_hashicorp_vault_transit.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ parameters:
VAULT_SKIP_VERIFY: "True"
auth: token
mount: transit
crypto_key: new_key
crypto_key: new_key
always_latest: False
```

Expand All @@ -76,7 +76,7 @@ Extra parameters that can be defined in inventory are:
* `auth`: specify which authentication method to use like `token`,`userpass`,`ldap`,`github` & `approle`
* `mount`: specify the mount point of key's path. e.g if path=`alpha-secret/foo/bar` then `mount: alpha-secret` (default `secret`)
* `crypto_key`: Name of the `encryption key` defined in vault
* `always_latest`: Always rewrap ciphertext to latest rotated `crypto_key` version
* `always_latest`: Always rewrap ciphertext to latest rotated `crypto_key` version
Environment variables __should NOT__ be defined in inventory are `VAULT_TOKEN`,`VAULT_USERNAME`,`VAULT_PASSWORD`,`VAULT_ROLE_ID`,`VAULT_SECRET_ID`.
This makes the secret_inside_kapitan file accessible throughout the inventory, where we can use the secret whenever necessary like `?{vaulttransit:${target_name}/secret_inside_kapitan}`

Expand Down
4 changes: 2 additions & 2 deletions docs/kap_proposals/kap_1_external_dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ parameters:
dependencies:
- type: git | http[s]
output_path: <output_path>
source: <git/http[s]_url>
source: <git/http[s]_url>
```
The output path is the path to save the dependency into. For example, it could be `/components/external/manifest.jsonnet`. Then, the user can specify the fetched file as a `kapitan.compile` item along with the locally-created files.
The output path is the path to save the dependency into. For example, it could be `/components/external/manifest.jsonnet`. Then, the user can specify the fetched file as a `kapitan.compile` item along with the locally-created files.

Git type may also include `ref` and `subdir` parameters as illustrated below:

Expand Down
Loading

0 comments on commit 205b77e

Please sign in to comment.