Skip to content

Commit

Permalink
docs.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
docs.yml committed Jan 12, 2024
1 parent 57ecc89 commit f3c4650
Show file tree
Hide file tree
Showing 14 changed files with 69 additions and 8 deletions.
10 changes: 10 additions & 0 deletions site/content/en/main/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,3 +145,13 @@ See [actions](./actions/) for more details.
## TypeScript

[TypeScript](https://www.typescriptlang.org/) is a strongly typed, object-oriented programming language built on top of JavaScript. It provides optional static typing and a rich type system, allowing developers to write more robust code. TypeScript is transpiled to JavaScript, enabling it to run in any environment that supports JavaScript. Pepr allows you to use JavaScript or TypeScript to write capabilities, but TypeScript is recommended for its type safety and rich type system. You can learn more about TypeScript [here](https://www.typescriptlang.org/docs/handbook/typescript-from-scratch.html).

## Community

To join our channel go to [Kubernetes Slack](https://communityinviter.com/apps/kubernetes/community) and join the `#pepr` channel.

<a href="https://github.com/defenseunicorns/pepr/graphs/contributors">
<img src="https://contrib.rocks/image?repo=defenseunicorns/pepr" />
</a>

Made with [contrib.rocks](https://contrib.rocks).
2 changes: 1 addition & 1 deletion site/content/en/v0.21.1/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: v0.21.1
cascade:
type: docs
aliases: ["/current/"]
aliases: []
---
# Pepr

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: v0.19.0
title: v0.22.0
cascade:
type: docs
aliases: []
aliases: ["/current/"]
---
# Pepr

Expand Down Expand Up @@ -33,7 +33,7 @@ Pepr is on a mission to save Kubernetes from the tyranny of YAML, intimidating g
- Entire NPM ecosystem available for advanced operations
- Realtime K8s debugging system for testing/reacting to cluster changes
- Controller network isolation and tamper-resistent module execution
- Automatic least-privilege RBAC generation [soon](https://github.com/defenseunicorns/pepr/issues/31)
- Least-privilege [RBAC](https://github.com/defenseunicorns/pepr/blob/main/docs/rbac/) generation
- AMD64 and ARM64 support

## Example Pepr Action
Expand Down Expand Up @@ -140,8 +140,18 @@ See [actions](./actions/) for more details.
## Logical Pepr Flow

![Arch Diagram](./_images/pepr-arch.svg)
[Source Diagram](./_images/pepr-arch.svg)
[Source Diagram](_images/pepr-arch.svg)

## TypeScript

[TypeScript](https://www.typescriptlang.org/) is a strongly typed, object-oriented programming language built on top of JavaScript. It provides optional static typing and a rich type system, allowing developers to write more robust code. TypeScript is transpiled to JavaScript, enabling it to run in any environment that supports JavaScript. Pepr allows you to use JavaScript or TypeScript to write capabilities, but TypeScript is recommended for its type safety and rich type system. You can learn more about TypeScript [here](https://www.typescriptlang.org/docs/handbook/typescript-from-scratch.html).

## Community

To join our channel go to [Kubernetes Slack](https://communityinviter.com/apps/kubernetes/community) and join the `#pepr` channel.

<a href="https://github.com/defenseunicorns/pepr/graphs/contributors">
<img src="https://contrib.rocks/image?repo=defenseunicorns/pepr" />
</a>

Made with [contrib.rocks](https://contrib.rocks).
Original file line number Diff line number Diff line change
Expand Up @@ -70,3 +70,4 @@ When(a.ConfigMap)
```
There are many more examples in the `HelloPepr` capability that you can use as a reference when creating your own actions. Note that each time you run [`pepr update`](../cli#pepr-update), Pepr will automatically update the `HelloPepr` capability with the latest examples and best practices for you to reference and test directly in your Pepr Module.
```

File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,44 @@ GET /metrics
pepr_Validate{quantile="0.999"} 201.23339900001884
pepr_Validate_sum 402.4275380000472
pepr_Validate_count 2
```
```

## Prometheus Operator

If using the Prometheus Operator, the following `ServiceMonitor` example manifests can be used to scrape the `/metrics` endpoint for the `admission` and `watcher` controllers.

```yaml
apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
name: admission
spec:
selector:
matchLabels:
pepr.dev/controller: admission
namespaceSelector:
matchNames:
- pepr-system
endpoints:
- targetPort: 3000
scheme: https
tlsConfig:
insecureSkipVerify: true
---
apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
name: watcher
spec:
selector:
matchLabels:
pepr.dev/controller: watcher
namespaceSelector:
matchNames:
- pepr-system
endpoints:
- targetPort: 3000
scheme: https
tlsConfig:
insecureSkipVerify: true
```
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions site/hugo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,12 @@ params:
url: https://github.com/defenseunicorns/pepr-docs
version_menu: Releases
versions:
- version: v0.22
url: /v0.22.0/
- version: v0.21
url: /v0.21.1/
- version: v0.20
url: /v0.20.3/
- version: v0.19
url: /v0.19.0/
- version: main
url: /main/
markup:
Expand Down

0 comments on commit f3c4650

Please sign in to comment.