Skip to content

fix: Update README with new k3d cluster creation command to work with… #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
venkatamutyala merged 1 commit into from
Apr 26, 2026
Merged

fix: Update README with new k3d cluster creation command to work with… #73

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

Run:
```bash
k3d cluster delete captain || true && curl https://raw.githubusercontent.com/GlueOps/k3d/main/k3d-config.yaml -o k3d-config.yaml && k3d cluster create --config k3d-config.yaml && bash <(curl -sL https://raw.githubusercontent.com/GlueOps/k3d/main/add-machineid.sh)
k3d cluster delete captain || true && docker network rm k3d-glueops-net || true && docker network create --driver bridge --opt com.docker.network.driver.mtu=1400 k3d-glueops-net && curl https://raw.githubusercontent.com/GlueOps/k3d/main/k3d-config.yaml -o k3d-config.yaml && k3d cluster create --config k3d-config.yaml && bash <(curl -sL https://raw.githubusercontent.com/GlueOps/k3d/main/add-machineid.sh)

Copilot AI Apr 26, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This single-line command is getting quite long and hard to troubleshoot when one step fails. Splitting it across multiple lines (continuations) or separating into a small script section in the README would improve readability and make failures easier for users to pinpoint.

Suggested change
k3d cluster delete captain || true && docker network rm k3d-glueops-net || true && docker network create --driver bridge --opt com.docker.network.driver.mtu=1400 k3d-glueops-net && curl https://raw.githubusercontent.com/GlueOps/k3d/main/k3d-config.yaml -o k3d-config.yaml && k3d cluster create --config k3d-config.yaml && bash <(curl -sL https://raw.githubusercontent.com/GlueOps/k3d/main/add-machineid.sh)
k3d cluster delete captain || true && \
docker network rm k3d-glueops-net || true && \
docker network create --driver bridge --opt com.docker.network.driver.mtu=1400 k3d-glueops-net && \
curl https://raw.githubusercontent.com/GlueOps/k3d/main/k3d-config.yaml -o k3d-config.yaml && \
k3d cluster create --config k3d-config.yaml && \
bash <(curl -sL https://raw.githubusercontent.com/GlueOps/k3d/main/add-machineid.sh)

Copilot uses AI. Check for mistakes.

Copilot AI Apr 26, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docker network rm ... || true can mask a failed removal (e.g., network still has active endpoints). In that case the subsequent docker network create ... k3d-glueops-net will fail because the network name already exists, stopping the whole chain. Consider either (1) making the create step tolerant of an existing network, or (2) explicitly detecting/remediating the “network in use” case and telling the user what to do (remove endpoints / pick a different network name) so the command is reliable.

Suggested change
k3d cluster delete captain || true && docker network rm k3d-glueops-net || true && docker network create --driver bridge --opt com.docker.network.driver.mtu=1400 k3d-glueops-net && curl https://raw.githubusercontent.com/GlueOps/k3d/main/k3d-config.yaml -o k3d-config.yaml && k3d cluster create --config k3d-config.yaml && bash <(curl -sL https://raw.githubusercontent.com/GlueOps/k3d/main/add-machineid.sh)
k3d cluster delete captain || true && docker network rm k3d-glueops-net || true && (docker network inspect k3d-glueops-net >/dev/null 2>&1 || docker network create --driver bridge --opt com.docker.network.driver.mtu=1400 k3d-glueops-net) && curl https://raw.githubusercontent.com/GlueOps/k3d/main/k3d-config.yaml -o k3d-config.yaml && k3d cluster create --config k3d-config.yaml && bash <(curl -sL https://raw.githubusercontent.com/GlueOps/k3d/main/add-machineid.sh)

Copilot uses AI. Check for mistakes.

Copilot AI Apr 26, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The curl https://... -o k3d-config.yaml download does not fail the command chain on HTTP errors (e.g., 404/500), which can lead to creating a cluster with an invalid/HTML config file. Using curl’s “fail on HTTP error” option (and keeping the rest of the pipeline unchanged) would make this setup command safer and easier to debug.

Suggested change
k3d cluster delete captain || true && docker network rm k3d-glueops-net || true && docker network create --driver bridge --opt com.docker.network.driver.mtu=1400 k3d-glueops-net && curl https://raw.githubusercontent.com/GlueOps/k3d/main/k3d-config.yaml -o k3d-config.yaml && k3d cluster create --config k3d-config.yaml && bash <(curl -sL https://raw.githubusercontent.com/GlueOps/k3d/main/add-machineid.sh)
k3d cluster delete captain || true && docker network rm k3d-glueops-net || true && docker network create --driver bridge --opt com.docker.network.driver.mtu=1400 k3d-glueops-net && curl -f https://raw.githubusercontent.com/GlueOps/k3d/main/k3d-config.yaml -o k3d-config.yaml && k3d cluster create --config k3d-config.yaml && bash <(curl -sL https://raw.githubusercontent.com/GlueOps/k3d/main/add-machineid.sh)

Copilot uses AI. Check for mistakes.
```

Run the request for new chisel nodes and then take the output to run against your k3ds cluster: https://tools.glueopshosted.rocks/docs#/default/create_chisel_nodes_v1_chisel_post
Expand Down
Loading