cozystack icon indicating copy to clipboard operation
cozystack copied to clipboard

cozyctl CLI

Open kevin880202 opened this issue 8 months ago • 9 comments

Hello team, it would be great to have a CLI tool. A CLI tool could make the cozystack admin experience better, including managing Cozystack and interacting with Cozystack api. The CLI could also be integrated with Talm and talos-bootstrap. cozyctl talm and cozyctl talos-bootstrap Here are some examples:

  1. cozyctl install -v 0.30 for
kubectl create ns cozy-system
kubectl apply -f cozystack-config.yaml
kubectl apply -f https://github.com/cozystack/cozystack/releases/download/v0.30.0/cozystack-installer.yaml
  1. cozyctl get monitoring-password -n tenant-root for
kubectl get secret -n tenant-root grafana-admin-password -o go-template='{{ printf "%s\n" (index .data "password" | base64decode) }}'
  1. cozyctl gen config --bundle paas-full for generating the manifests
  2. cozyctl deploy kubernetes for deploying a kubernetes through capi

kevin880202 avatar Apr 17 '25 12:04 kevin880202

I believe, talm is close to what you are talking about for deployment tasks

https://cozystack.io/docs/operations/talos/configuration/talm/

NickVolynkin avatar Apr 17 '25 12:04 NickVolynkin

Talm is only for managing talos linux, not the cozystack platform. I hope there is a CLI tool for the platform itself to make some operations easier.

kevin880202 avatar Apr 17 '25 12:04 kevin880202

I love this idea, we can create a kubectl plugin an distribute it via krew

kvaps avatar Apr 17 '25 21:04 kvaps

I also like this idea!

gecube avatar Apr 18 '25 06:04 gecube

now that the Feature tag is added, can we start to work on this feature?

If so, I'd like to start the CLI work, if you are planning a sub-module or a separate repository for it, these have beeb discussed in a community meeting?

cc: @kvaps @NickVolynkin

rxinui avatar Apr 30 '25 21:04 rxinui

Hey @rxinui I started working on cozypkg tool, but it is more for local development https://github.com/cozystack/cozystack/pull/1050

FYI

If so, I'd like to start the CLI work, if you are planning a sub-module or a separate repository for it, these have beeb discussed in a community meeting?

Please come to our community meeting to discuss

kvaps avatar Jun 10 '25 18:06 kvaps

Hi, @kevin880202. I'm Dosu, and I'm helping the cozystack team manage their backlog and am marking this issue as stale.

Issue Summary

  • You proposed creating a CLI tool called cozyctl to simplify Cozystack platform management and API interactions.
  • The community acknowledged that existing tools like Talm do not cover the Cozystack platform itself, supporting the need for a dedicated CLI.
  • Contributors expressed enthusiasm, with suggestions such as a kubectl plugin distributed via krew and ongoing related work on cozypkg.
  • Another user showed interest in starting CLI development and was encouraged to discuss plans in the community meeting.
  • The issue remains unresolved with no recent updates or progress reported.

Next Steps

  • Please let me know if this issue is still relevant to the latest version of the cozystack repository by commenting here to keep the discussion open.
  • Otherwise, I will automatically close this issue in 7 days.

Thank you for your understanding and contribution!

dosubot[bot] avatar Oct 20 '25 16:10 dosubot[bot]

Please keep the feature request open.

kevin880202 avatar Oct 22 '25 15:10 kevin880202

@NickVolynkin The user has requested to keep the CLI tool feature request open for cozyctl. Could you please assist with this?

dosubot[bot] avatar Oct 22 '25 15:10 dosubot[bot]