Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release v0.1.17 #248

Merged
merged 8 commits into from
May 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/.reusable-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ jobs:
- name: Install poetry
uses: snok/install-poetry@93ada01c735cc8a383ce0ce2ae205a21c415379b # v1.3.4
with:
version: 1.7.1
version: 1.8.3
virtualenvs-create: false
virtualenvs-in-project: false
installer-parallel: true
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/.reusable-sast.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ jobs:
- name: Install poetry
uses: snok/install-poetry@93ada01c735cc8a383ce0ce2ae205a21c415379b # v1.3.4
with:
version: 1.7.1
version: 1.8.3
virtualenvs-create: false
virtualenvs-in-project: false
installer-parallel: true
Expand Down Expand Up @@ -68,7 +68,7 @@ jobs:
- name: Install poetry
uses: snok/install-poetry@93ada01c735cc8a383ce0ce2ae205a21c415379b # v1.3.4
with:
version: 1.7.1
version: 1.8.3
virtualenvs-create: false
virtualenvs-in-project: false
installer-parallel: true
Expand Down Expand Up @@ -217,7 +217,7 @@ jobs:
- name: Install poetry
uses: snok/install-poetry@93ada01c735cc8a383ce0ce2ae205a21c415379b # v1.3.4
with:
version: 1.7.1
version: 1.8.3
virtualenvs-create: false
virtualenvs-in-project: false
installer-parallel: true
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/.reusable-unit-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ jobs:
- name: Install poetry
uses: snok/install-poetry@93ada01c735cc8a383ce0ce2ae205a21c415379b # v1.3.4
with:
version: 1.7.1
version: 1.8.3
virtualenvs-create: false
virtualenvs-in-project: false
installer-parallel: true
Expand Down Expand Up @@ -96,7 +96,7 @@ jobs:
- name: Install poetry
uses: snok/install-poetry@93ada01c735cc8a383ce0ce2ae205a21c415379b # v1.3.4
with:
version: 1.7.1
version: 1.8.3
virtualenvs-create: false
virtualenvs-in-project: false
installer-parallel: true
Expand Down
25 changes: 12 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,35 @@
![](docs/assets/semgr8s-logo-full-dark.png#gh-dark-mode-only)
![](docs/assets/semgr8s-logo-full-light.png#gh-light-mode-only)
![](assets/semgr8s-logo-full-dark.png#gh-dark-mode-only)
![](assets/semgr8s-logo-full-light.png#gh-light-mode-only)
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/assets/semgr8s-logo-full-dark.png">
<source media="(prefers-color-scheme: light)" srcset="docs/assets/semgr8s-logo-full-light.png">
<img alt="Semgr8s logo" src="docs/assets/semgr8s-logo-full-light.png">
</picture>

<h2 align="center">
Semgrep-based Policy controller for Kubernetes.
</h2>

Admission controller to use your well-known publicly available or custom Semgrep rules to validate k8s resources before deployment to the cluster.

:hammer_and_wrench: developed by ![](docs/assets/sse-logo-dark.svg#gh-dark-mode-only)![](docs/assets/sse-logo-light.svg#gh-light-mode-only)[![](assets/sse-logo-dark.svg#gh-dark-mode-only)![](assets/sse-logo-light.svg#gh-light-mode-only)](https://securesystems.de/)
:hammer_and_wrench: developed by <a href="https://securesystems.de/"><picture><source media="(prefers-color-scheme: dark)" srcset="docs/assets/sse-logo-dark.svg"><source media="(prefers-color-scheme: light)" srcset="docs/assets/sse-logo-light.svg"><img alt="Semgr8s logo" src="docs/assets/sse-logo-light.svg"></picture></a>

:zap: powered by ![](docs/assets/semgrep-logo-dark.svg#gh-dark-mode-only)![](docs/assets/semgrep-logo-light.svg#gh-light-mode-only)[![](assets/semgrep-logo-dark.svg#gh-dark-mode-only)![](assets/semgrep-logo-light.svg#gh-light-mode-only)](https://semgrep.dev)
:zap: powered by <a href="https://semgrep.dev/"><picture><source media="(prefers-color-scheme: dark)" srcset="docs/assets/semgrep-logo-dark.svg"><source media="(prefers-color-scheme: light)" srcset="docs/assets/semgrep-logo-light.svg"><img alt="Semgr8s logo" src="docs/assets/semgrep-logo-light.svg"></picture></a>

> :warning: semgr8s is in a proof-of-concept state. Do not use in production. Breaking changes, service interruptions, and development flow adjustments are expected.
> :warning: Semgr8s is in a proof-of-concept state. Do not use in production. Breaking changes, service interruptions, and development flow adjustments are expected.

### :point_right: More? Read the [docs](https://semgr8ns.github.io/semgr8s/latest/).

## Getting started

Getting started to validate Kubernetes resources against Semgrep rules is only a matter of minutes:

![](docs/assets/semgr8s-demo.gif)
![](assets/semgr8s-demo.gif)

### Requirements

- [git](https://git-scm.com/)
- Kubernetes cluster for testing (e.g. [kind](https://kind.sigs.k8s.io/), [microk8s](https://microk8s.io/docs), or [minikube](https://minikube.sigs.k8s.io/docs/start/))
- [kubectl](https://kubernetes.io/docs/reference/kubectl/)
- [Helm](https://helm.sh/)
- *(optional)* [yq v4.x](https://mikefarah.gitbook.io/yq/)
- *(optional)* [make](https://www.gnu.org/software/make/) (e.g. via [build-essential](https://packages.ubuntu.com/focal/build-essential))
- *(optional)* [docker](https://docs.docker.com/get-docker/)

### Get Code

Expand Down Expand Up @@ -72,7 +71,7 @@ helm install semgr8s charts/semgr8s --create-namespace --namespace semgr8ns
```
</details>

You can check successful deployment of semgr8s via:
You can check successful deployment of Semgr8s via:

```bash
kubectl get all -n semgr8ns
Expand All @@ -95,7 +94,7 @@ kubectl get all -n semgr8ns
```
</details>

Once all resources are in `READY` state, you have successfully installed semgr8s :rocket:
Once all resources are in `READY` state, you have successfully installed Semgr8s :rocket:

### Testing

Expand Down
4 changes: 2 additions & 2 deletions charts/semgr8s/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ apiVersion: v2
name: semgr8s
description: Semgrep-based Policy Controller for Kubernetes
type: application
version: "0.1.16"
appVersion: "0.1.16"
version: "0.1.17"
appVersion: "0.1.17"
keywords:
- kubernetes
- admission controller
Expand Down
1 change: 0 additions & 1 deletion docs/README.md

This file was deleted.

Loading
Loading