From 19b87a074800a411922cd49a89c45b50ab718e8f Mon Sep 17 00:00:00 2001 From: kranurag7 Date: Fri, 1 Mar 2024 14:26:22 +0530 Subject: [PATCH] add csctl installation docs Signed-off-by: kranurag7 --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index ad350729..a5942980 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,31 @@ - [CSCTL](#csctl) - [Table of Contents](#table-of-contents) + - [Installation](#installation) - [Introduction](#introduction) - [Features of csctl](#features-of-csctl) - [Docs](#docs) +## Installation +To download `csctl` there are two ways. +Go to https://github.com/SovereignCloudStack/csctl/releases/latest and then click on the binary. The name of the binary looks similar to this ` +csctl_0.0.2_linux_amd64` for Linux amd64 architecture. + +This will download the binary in your `~/Downloads` directory. Use the following commands to move it to your PATH. +```bash +chmod u+x ~/Downloads/csctl_0.0.2_linux_amd64 +sudo mv ~/Downloads/csctl_0.0.2_linux_amd64 /usr/local/bin/csctl +``` + +Alternative way of installing the binary is to use `[gh](https://github.com/cli/cli)` command line tool. +Use the following command to download the latest binary from GitHub. +```bash +gh release download -p 'csctl_*_linux_amd64' -R SovereignCloudStack/csctl +chmod u+x csctl_0.0.2_linux_amd64 +sudo mv ./csctl_0.0.2_linux_amd64 /usr/local/bin/csctl +``` +For darwin based systems, the steps are similar, you'll have to choose darwin based binaries instead of linux one mentioned above. You'll also need to update your destination directory. + ## Introduction The [Cluster Stack Operator](https://github.com/SovereignCloudStack/cluster-stack-operator) facilitates the usage of [Cluster Stacks](https://github.com/SovereignCloudStack/cluster-stacks) by automating all steps that can be automated. It takes Cluster Stacks release assets that consist mainly of two Helm charts, one to deploy in the management cluster, the other one to deploy in the workload clusters, as well as provider-specific node image (build) information.