https://github.com/defenseunicorns/pepr-excellent-examples
Welcome to the Pepr Examples Repository!
https://github.com/defenseunicorns/pepr-excellent-examples
admission-controller admission-webhook defense-unicorns-preserve kubernetes typescript
Last synced: 7 months ago
JSON representation
Welcome to the Pepr Examples Repository!
- Host: GitHub
- URL: https://github.com/defenseunicorns/pepr-excellent-examples
- Owner: defenseunicorns
- Created: 2023-11-02T23:08:50.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-11T18:00:31.000Z (7 months ago)
- Last Synced: 2025-04-11T18:41:33.051Z (7 months ago)
- Topics: admission-controller, admission-webhook, defense-unicorns-preserve, kubernetes, typescript
- Language: TypeScript
- Homepage: https://pepr.dev
- Size: 2.68 MB
- Stars: 6
- Watchers: 4
- Forks: 1
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pepr Excellent Examples
This repository is a collection of examples exercising the capabilities of Pepr.
Here, you'll find practical implementations of Pepr Modules to cover various scenarios. Whether you're new to Pepr or an experienced user, these examples will help you understand how to build and deploy applications effectively.
## Exercising the Examples
Most examples are designed around a test suite that demonstrates / verifies how they work.
To run all example suites:
```sh
npm run test:e2e
```
To run a single example suite, specify which to run using `-w` flag:
```sh
# npm run test:e2e -w
npm run test:e2e -w hello-pepr-validate
```
To run a subset of tests, give Jest the specifics via the `--passthru` flag:
```sh
# npm run test:e2e -w -- --passthru=""
npm run test:e2e -w hello-pepr-validate -- --passthru="--testNamePattern='validate creates'"
```
## Digging In
### Viewing an Example Cluster (via K9s)
```sh
# KUBECONFIG=$(k3d kubeconfig write pexex--e2e) k9s
KUBECONFIG=$(k3d kubeconfig write pexex-hello-pepr-watch-e2e) k9s
```
Note: the tests will _automatically_ clean these clusters up when they complete, so be sure to Ctrl+C-out of a running suite if you wanna poke around!
### Testing with a development version of the Pepr controller
To run all example suites against a custom version of the Pepr controller, specify an image tag using the `--image` flag:
```sh
npm run test:e2e -- --image pepr:dev
```
### Testing with a development version of the Pepr lib
You can use the symbolic linking to swap-in a development version of the `pepr` package when building the excellent examples -- a particularly useful ability when co-developing new Pepr features + associated examples.
#### Setup
```sh
cd
npm run build
cd
npm install
rm -rf node_modules/pepr
ln -s node_modules/pepr
```
#### Cleanup
```sh
cd
rm -rf node_modules
npm install
```