mirror of https://github.com/k3d-io/k3d
parent
f571ff3143
commit
bc49f197d9
@ -1,29 +1,29 @@ |
|||||||
dist: bionic |
dist: bionic |
||||||
language: go |
language: go |
||||||
env: |
env: |
||||||
- GO111MODULE=on |
- GO111MODULE=on |
||||||
go: |
go: |
||||||
- 1.13.x |
- 1.13.x |
||||||
git: |
git: |
||||||
depth: 1 |
depth: 1 |
||||||
install: true |
install: true |
||||||
before_script: |
before_script: |
||||||
- curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b ${GOPATH}/bin v1.20.0 |
- curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b ${GOPATH}/bin v1.22.2 |
||||||
- go get github.com/mitchellh/gox@v1.0.1 |
- go get github.com/mitchellh/gox@v1.0.1 |
||||||
script: |
script: |
||||||
- make fmt check build-cross |
- make fmt check build-cross |
||||||
deploy: |
deploy: |
||||||
provider: releases |
provider: releases |
||||||
skip_cleanup: true |
skip_cleanup: true |
||||||
api_key: |
api_key: |
||||||
secure: VFb0jmL6t+cuKWAGC5OLeseTJrK3CakD5Laeyp0JVG/o3/cYgHP0lIeDmJJMZL/Luxm5aL8QHsCRfQoMBAnj6Q8hchI9rbcYhFZzuFJYyDxjcrPm0+kM3yiK14lQZNvksy2ZSsO7D63c8x9sQVrEus4idVTUoxrpSXLM2eVjl6W0O2RdZvLsxgaLPwV1ufpihrqbXdEUjt/YSYpHiC5gS3o+FcyMGucJQdN/L7p6jyAqVgg4+t8bdyWj6+MEG4p8lmWhhbGzDo38iMxtCBu+nDHRsbivay3eJZ643VguX0lj62Vt5KUTcVJntmZqQ2UF6FoEVUPOegkrSeoiMuOH1+nYwcsfMFijMkrcFhb6bAisJJd6agdhFWXiSwL88FQkJh0DqeA0tFFIzDbTS/AZTY4Li8bWng3aCBgSXiMzIBf0es+wMDw0gwhfH44Y/RAsKSQJ/Lln00AaVzkOkOWOmu5Ks0CVYDy0M5QDQOCW2E9TIb7WdIMh3aNCkZi+rGovigejJv3vUZqkN03Og07Hbrjgfg28iY3isIt3soOrVqek2hJJFnKjUhhv2OhJm3z6FpTyMViUtSmJ+LTiBjpyiWC4QuaITDadCJTxZQwobhI+18c2Zi5/HjTX1pgD1wk3quv9R4bGjVINenefG6xxaNj+CeFTfrQnnHuXOL50828= |
secure: VFb0jmL6t+cuKWAGC5OLeseTJrK3CakD5Laeyp0JVG/o3/cYgHP0lIeDmJJMZL/Luxm5aL8QHsCRfQoMBAnj6Q8hchI9rbcYhFZzuFJYyDxjcrPm0+kM3yiK14lQZNvksy2ZSsO7D63c8x9sQVrEus4idVTUoxrpSXLM2eVjl6W0O2RdZvLsxgaLPwV1ufpihrqbXdEUjt/YSYpHiC5gS3o+FcyMGucJQdN/L7p6jyAqVgg4+t8bdyWj6+MEG4p8lmWhhbGzDo38iMxtCBu+nDHRsbivay3eJZ643VguX0lj62Vt5KUTcVJntmZqQ2UF6FoEVUPOegkrSeoiMuOH1+nYwcsfMFijMkrcFhb6bAisJJd6agdhFWXiSwL88FQkJh0DqeA0tFFIzDbTS/AZTY4Li8bWng3aCBgSXiMzIBf0es+wMDw0gwhfH44Y/RAsKSQJ/Lln00AaVzkOkOWOmu5Ks0CVYDy0M5QDQOCW2E9TIb7WdIMh3aNCkZi+rGovigejJv3vUZqkN03Og07Hbrjgfg28iY3isIt3soOrVqek2hJJFnKjUhhv2OhJm3z6FpTyMViUtSmJ+LTiBjpyiWC4QuaITDadCJTxZQwobhI+18c2Zi5/HjTX1pgD1wk3quv9R4bGjVINenefG6xxaNj+CeFTfrQnnHuXOL50828= |
||||||
file: |
file: |
||||||
- _dist/k3d-darwin-amd64 |
- _dist/k3d-darwin-amd64 |
||||||
- _dist/k3d-linux-386 |
- _dist/k3d-linux-386 |
||||||
- _dist/k3d-linux-amd64 |
- _dist/k3d-linux-amd64 |
||||||
- _dist/k3d-linux-arm |
- _dist/k3d-linux-arm |
||||||
- _dist/k3d-linux-arm64 |
- _dist/k3d-linux-arm64 |
||||||
- _dist/k3d-windows-amd64.exe |
- _dist/k3d-windows-amd64.exe |
||||||
on: |
on: |
||||||
repo: rancher/k3d |
repo: rancher/k3d |
||||||
tags: true |
tags: true |
||||||
|
@ -1,185 +1,3 @@ |
|||||||
# Examples |
# Examples |
||||||
|
|
||||||
## Expose services |
Under construction... |
||||||
|
|
||||||
### 1. via Ingress |
|
||||||
|
|
||||||
1. Create a cluster, mapping the ingress port 80 to localhost:8081 |
|
||||||
|
|
||||||
`k3d create --api-port 6550 --publish 8081:80 --workers 2` |
|
||||||
|
|
||||||
- Note: `--api-port 6550` is not required for the example to work. It's used to have `k3s`'s ApiServer 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` |
|
||||||
|
|
||||||
```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 --publish 8082:30080@k3d-k3s-default-worker-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/` |
|
||||||
|
|
||||||
## Connect with a local insecure registry |
|
||||||
|
|
||||||
This guide takes you through setting up a local insecure (http) registry and integrating it into your workflow so that: |
|
||||||
- you can push to the registry from your host |
|
||||||
- the cluster managed by k3d can pull from that registry |
|
||||||
|
|
||||||
The registry will be named `registry.local` and run on port `5000`. |
|
||||||
### Create the registry |
|
||||||
|
|
||||||
<pre> |
|
||||||
docker volume create local_registry |
|
||||||
|
|
||||||
docker container run -d --name <b>registry.local</b> -v local_registry:/var/lib/registry --restart always -p <b>5000:5000</b> registry:2 |
|
||||||
</pre> |
|
||||||
|
|
||||||
### Create the cluster with k3d |
|
||||||
|
|
||||||
First we need a place to store the config template: `mkdir -p /home/${USER}/.k3d` |
|
||||||
|
|
||||||
Create a file named `config.toml.tmpl` in `/home/${USER}/.k3d`, with following content: |
|
||||||
|
|
||||||
<pre> |
|
||||||
# Original section: no changes |
|
||||||
[plugins.opt] |
|
||||||
path = "{{ .NodeConfig.Containerd.Opt }}" |
|
||||||
[plugins.cri] |
|
||||||
stream_server_address = "{{ .NodeConfig.AgentConfig.NodeName }}" |
|
||||||
stream_server_port = "10010" |
|
||||||
{{- if .IsRunningInUserNS }} |
|
||||||
disable_cgroup = true |
|
||||||
disable_apparmor = true |
|
||||||
restrict_oom_score_adj = true |
|
||||||
{{ end -}} |
|
||||||
{{- if .NodeConfig.AgentConfig.PauseImage }} |
|
||||||
sandbox_image = "{{ .NodeConfig.AgentConfig.PauseImage }}" |
|
||||||
{{ end -}} |
|
||||||
{{- if not .NodeConfig.NoFlannel }} |
|
||||||
[plugins.cri.cni] |
|
||||||
bin_dir = "{{ .NodeConfig.AgentConfig.CNIBinDir }}" |
|
||||||
conf_dir = "{{ .NodeConfig.AgentConfig.CNIConfDir }}" |
|
||||||
{{ end -}} |
|
||||||
|
|
||||||
# Added section: additional registries and the endpoints |
|
||||||
[plugins.cri.registry.mirrors] |
|
||||||
[plugins.cri.registry.mirrors."<b>registry.local:5000</b>"] |
|
||||||
endpoint = ["http://<b>registry.local:5000</b>"] |
|
||||||
</pre> |
|
||||||
|
|
||||||
Finally start a cluster with k3d, passing-in the config template: |
|
||||||
|
|
||||||
``` |
|
||||||
CLUSTER_NAME=k3s-default |
|
||||||
k3d create \ |
|
||||||
--name ${CLUSTER_NAME} \ |
|
||||||
--wait 0 \ |
|
||||||
--auto-restart \ |
|
||||||
--volume /home/${USER}/.k3d/config.toml.tmpl:/var/lib/rancher/k3s/agent/etc/containerd/config.toml.tmpl |
|
||||||
``` |
|
||||||
|
|
||||||
### Wire them up |
|
||||||
|
|
||||||
- Connect the registry to the cluster network: `docker network connect k3d-k3s-default registry.local` |
|
||||||
- Add `127.0.0.1 registry.local` to your `/etc/hosts` |
|
||||||
|
|
||||||
### Test |
|
||||||
|
|
||||||
Push an image to the registry: |
|
||||||
|
|
||||||
``` |
|
||||||
docker pull nginx:latest |
|
||||||
docker tag nginx:latest registry.local:5000/nginx:latest |
|
||||||
docker push registry.local:5000/nginx:latest |
|
||||||
``` |
|
||||||
|
|
||||||
Deploy a pod referencing this image to your cluster: |
|
||||||
|
|
||||||
``` |
|
||||||
cat <<EOF | kubectl apply -f - |
|
||||||
apiVersion: apps/v1 |
|
||||||
kind: Deployment |
|
||||||
metadata: |
|
||||||
name: nginx-test-registry |
|
||||||
labels: |
|
||||||
app: nginx-test-registry |
|
||||||
spec: |
|
||||||
replicas: 1 |
|
||||||
selector: |
|
||||||
matchLabels: |
|
||||||
app: nginx-test-registry |
|
||||||
template: |
|
||||||
metadata: |
|
||||||
labels: |
|
||||||
app: nginx-test-registry |
|
||||||
spec: |
|
||||||
containers: |
|
||||||
- name: nginx-test-registry |
|
||||||
image: registry.local:5000/nginx:latest |
|
||||||
ports: |
|
||||||
- containerPort: 80 |
|
||||||
EOF |
|
||||||
``` |
|
||||||
|
|
||||||
... and check that the pod is running: `kubectl get pods -l "app=nginx-test-registry"` |
|
||||||
|
@ -1,4 +1,4 @@ |
|||||||
# FAQ / Nice to know |
# FAQ / Nice to know |
||||||
|
|
||||||
- As [@jaredallard](https://github.com/jaredallard) [pointed out](https://github.com/rancher/k3d/pull/48), people running `k3d` on a system with **btrfs**, may need to mount `/dev/mapper` into the nodes for the setup to work. |
- As [@jaredallard](https://github.com/jaredallard) [pointed out](https://github.com/rancher/k3d/pull/48), people running `k3d` on a system with **btrfs**, may need to mount `/dev/mapper` into the nodes for the setup to work. |
||||||
- This will do: `k3d create -v /dev/mapper:/dev/mapper` |
- This will do: `k3d create cluster CLUSTER_NAME -v /dev/mapper:/dev/mapper` |
||||||
|
Loading…
Reference in new issue