Skip to content

Commit fa96946

Browse files
authored
Add K3s module (#864)
1 parent ff63418 commit fa96946

File tree

10 files changed

+758
-46
lines changed

10 files changed

+758
-46
lines changed

docs/modules/k3s.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# K3s Module
2+
3+
[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.
4+
5+
## Install
6+
7+
```bash
8+
npm install @testcontainers/k3s --save-dev
9+
```
10+
11+
## Examples
12+
13+
<!--codeinclude-->
14+
[Starting a K3s server:](../../packages/modules/k3s/src/k3s-container.test.ts) inside_block:starting_k3s
15+
<!--/codeinclude-->
16+
17+
<!--codeinclude-->
18+
[Connecting to the server using the Kubernetes JavaScript client:](../../packages/modules/k3s/src/k3s-container.test.ts) inside_block:connecting_with_client
19+
<!--/codeinclude-->
20+
21+
## Known limitations
22+
23+
!!! warning
24+
* K3sContainer runs as a privileged container and needs to be able to spawn its own containers. For these reasons,
25+
K3sContainer will not work in certain rootless Docker, Docker-in-Docker, or other environments where privileged
26+
containers are disallowed.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ nav:
5050
- Elasticsearch: modules/elasticsearch.md
5151
- GCloud: modules/gcloud.md
5252
- HiveMQ: modules/hivemq.md
53+
- K3s: modules/k3s.md
5354
- Kafka: modules/kafka.md
5455
- Localstack: modules/localstack.md
5556
- MariaDB: modules/mariadb.md

0 commit comments

Comments
 (0)