Skip to content

Commit

Permalink
Fix pre-commit issues
Browse files Browse the repository at this point in the history
  • Loading branch information
cristiklein committed Dec 2, 2024
1 parent e49da72 commit 3c2ad04
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ GitHub Actions will deploy the `main` branch automatically.

## Known Issues

### nodeenv provided with Ubuntu 24.04 is old
### `nodeenv` provided with Ubuntu 24.04 is old

If you get the following errors:

Expand All @@ -81,12 +81,12 @@ An unexpected error has occurred: CalledProcessError: command: ('/usr/bin/python
                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
```

Then this could be caused by the version of nodeenv delivered with Ubuntu 24.04.
Then this could be caused by the version of `nodeenv` delivered with Ubuntu 24.04.
You have two options.

#### Option 1: Run pre-commit from a virtual environment

1. Remove Ubuntu's pre-commit and nodeenv: `sudo apt purge nodeenv --autoremove`.
1. Remove Ubuntu's pre-commit and `nodeenv`: `sudo apt purge nodeenv --autoremove`.
1. Activate the virtual environment you created above: `. .venv/bin/activate`.
1. Install pre-commit in the virtual environment: `pip install pre-commit`.
1. Run pre-commit from the virtual environment: `pre-commit run --all`.
Expand Down
1 change: 1 addition & 0 deletions ci/vale/styles/config/vocabularies/Elastisys/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ VM

# Kubernetes terms
Autoscaler
autoscaled
CRD
CronJob
finalizer
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

We previously decided to allow [configuration snippet annotations](https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/#configuration-snippet) for Ingress NGINX, but only after formal risk acceptance from the Application Developer. However, we had not yet decided on handling specific use cases, such as whether [server snippets](https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/#server-snippet) should have stricter controls due to their higher risk profile.

The difference is that config snippets allows to configure for whole location blocks and are validated by the Ingress Controller, while server snippets allows to configure for whole server block and are not validated by the Ingress Controller, they are passed directly to NGINX, which increases the vulnerability exposure area.
The difference is that configuration snippets allows to configure for whole location blocks and are validated by the Ingress Controller, while server snippets allows to configure for whole server block and are not validated by the Ingress Controller, they are passed directly to NGINX, which increases the vulnerability exposure area.

[Snippet Annotations](https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/) are a powerful tool to allow injecting custom configurations, including both configuration and server snippets, into the Ingress NGINX Controller. For example, it allows things such as header renaming, custom authentication, or other advanced use cases etc.

Expand Down

0 comments on commit 3c2ad04

Please sign in to comment.