docs: use awesome-pages structure and add content
This commit is contained in:
parent
42b7dc30b9
commit
5ce4733cc5
5
docs/.pages
Normal file
5
docs/.pages
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
arrange:
|
||||||
|
- index.md
|
||||||
|
- commands.md
|
||||||
|
- defaults.md
|
||||||
|
- faq.md
|
1
docs/CNAME
Normal file
1
docs/CNAME
Normal file
@ -0,0 +1 @@
|
|||||||
|
k3d.io
|
4
docs/examples/.pages
Normal file
4
docs/examples/.pages
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
title: Examples
|
||||||
|
arrange:
|
||||||
|
- exposing_services.md
|
||||||
|
- registries.md
|
83
docs/examples/exposing_services.md
Normal file
83
docs/examples/exposing_services.md
Normal file
@ -0,0 +1,83 @@
|
|||||||
|
# Exposing Services
|
||||||
|
|
||||||
|
## 1. via Ingress
|
||||||
|
|
||||||
|
In this example, we will deploy a simple nginx webserver deployment and make it accessible via ingress.
|
||||||
|
Therefore, we have to create the cluster in a way, that the internal port 80 (where the `traefik` ingress controller is listening on) is exposed on the host system.
|
||||||
|
|
||||||
|
1. Create a cluster, mapping the ingress port 80 to localhost:8081
|
||||||
|
|
||||||
|
`k3d create cluster --api-port 6550 -p 8081:80 --workers 2`
|
||||||
|
|
||||||
|
- Note: `--api-port 6550` is not required for the example to work. It's used to have `k3s`'s API-Server listening on port 6550 with that port mapped to the host system.
|
||||||
|
|
||||||
|
2. Get the kubeconfig file
|
||||||
|
|
||||||
|
`export KUBECONFIG="$(k3d get-kubeconfig --name='k3s-default')"`
|
||||||
|
|
||||||
|
3. Create a nginx deployment
|
||||||
|
|
||||||
|
`kubectl create deployment nginx --image=nginx`
|
||||||
|
|
||||||
|
4. Create a ClusterIP service for it
|
||||||
|
|
||||||
|
`kubectl create service clusterip nginx --tcp=80:80`
|
||||||
|
|
||||||
|
5. Create an ingress object for it with `kubectl apply -f`
|
||||||
|
*Note*: `k3s` deploys [`traefik`](https://github.com/containous/traefik) as the default ingress controller
|
||||||
|
|
||||||
|
```YAML
|
||||||
|
apiVersion: extensions/v1beta1
|
||||||
|
kind: Ingress
|
||||||
|
metadata:
|
||||||
|
name: nginx
|
||||||
|
annotations:
|
||||||
|
ingress.kubernetes.io/ssl-redirect: "false"
|
||||||
|
spec:
|
||||||
|
rules:
|
||||||
|
- http:
|
||||||
|
paths:
|
||||||
|
- path: /
|
||||||
|
backend:
|
||||||
|
serviceName: nginx
|
||||||
|
servicePort: 80
|
||||||
|
```
|
||||||
|
|
||||||
|
6. Curl it via localhost
|
||||||
|
|
||||||
|
`curl localhost:8081/`
|
||||||
|
|
||||||
|
## 2. via NodePort
|
||||||
|
|
||||||
|
1. Create a cluster, mapping the port 30080 from worker-0 to localhost:8082
|
||||||
|
|
||||||
|
`k3d create cluster mycluster -p 8082:30080@kworker[0] --workers 2`
|
||||||
|
|
||||||
|
- Note: Kubernetes' default NodePort range is [`30000-32767`](https://kubernetes.io/docs/concepts/services-networking/service/#nodeport)
|
||||||
|
|
||||||
|
... (Steps 2 and 3 like above) ...
|
||||||
|
|
||||||
|
1. Create a NodePort service for it with `kubectl apply -f`
|
||||||
|
|
||||||
|
```YAML
|
||||||
|
apiVersion: v1
|
||||||
|
kind: Service
|
||||||
|
metadata:
|
||||||
|
labels:
|
||||||
|
app: nginx
|
||||||
|
name: nginx
|
||||||
|
spec:
|
||||||
|
ports:
|
||||||
|
- name: 80-80
|
||||||
|
nodePort: 30080
|
||||||
|
port: 80
|
||||||
|
protocol: TCP
|
||||||
|
targetPort: 80
|
||||||
|
selector:
|
||||||
|
app: nginx
|
||||||
|
type: NodePort
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Curl it via localhost
|
||||||
|
|
||||||
|
`curl localhost:8082/`
|
5
docs/examples/registries.md
Normal file
5
docs/examples/registries.md
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
# Registries
|
||||||
|
|
||||||
|
## Registries configuration file
|
||||||
|
|
||||||
|
...
|
Loading…
Reference in New Issue
Block a user