Skip to content
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
26 changes: 26 additions & 0 deletions docs/modules/k3s.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# K3s Module

[K3s](https://k3s.io/) is a highly available, certified Kubernetes distribution designed for production workloads in unattended, resource-constrained, remote locations or inside IoT appliances.

## Install

```bash
npm install @testcontainers/k3s --save-dev
```

## Examples

<!--codeinclude-->
[Starting a K3s server:](../../packages/modules/k3s/src/k3s-container.test.ts) inside_block:starting_k3s
<!--/codeinclude-->

<!--codeinclude-->
[Connecting to the server using the Kubernetes JavaScript client:](../../packages/modules/k3s/src/k3s-container.test.ts) inside_block:connecting_with_client
<!--/codeinclude-->

## Known limitations

!!! warning
* K3sContainer runs as a privileged container and needs to be able to spawn its own containers. For these reasons,
K3sContainer will not work in certain rootless Docker, Docker-in-Docker, or other environments where privileged
containers are disallowed.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ nav:
- Elasticsearch: modules/elasticsearch.md
- GCloud: modules/gcloud.md
- HiveMQ: modules/hivemq.md
- K3s: modules/k3s.md
- Kafka: modules/kafka.md
- Localstack: modules/localstack.md
- MariaDB: modules/mariadb.md
Expand Down
Loading
Loading