Skip to content

Commit 19b87a0

Browse files
kranurag7jschoone
kranurag7
authored andcommitted
add csctl installation docs
Signed-off-by: kranurag7 <anurag.kumar@syself.com>
1 parent 98772be commit 19b87a0

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,31 @@
44

55
- [CSCTL](#csctl)
66
- [Table of Contents](#table-of-contents)
7+
- [Installation](#installation)
78
- [Introduction](#introduction)
89
- [Features of csctl](#features-of-csctl)
910
- [Docs](#docs)
1011

12+
## Installation
13+
To download `csctl` there are two ways.
14+
Go to https://github.com/SovereignCloudStack/csctl/releases/latest and then click on the binary. The name of the binary looks similar to this `
15+
csctl_0.0.2_linux_amd64` for Linux amd64 architecture.
16+
17+
This will download the binary in your `~/Downloads` directory. Use the following commands to move it to your PATH.
18+
```bash
19+
chmod u+x ~/Downloads/csctl_0.0.2_linux_amd64
20+
sudo mv ~/Downloads/csctl_0.0.2_linux_amd64 /usr/local/bin/csctl
21+
```
22+
23+
Alternative way of installing the binary is to use `[gh](https://github.com/cli/cli)` command line tool.
24+
Use the following command to download the latest binary from GitHub.
25+
```bash
26+
gh release download -p 'csctl_*_linux_amd64' -R SovereignCloudStack/csctl
27+
chmod u+x csctl_0.0.2_linux_amd64
28+
sudo mv ./csctl_0.0.2_linux_amd64 /usr/local/bin/csctl
29+
```
30+
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.
31+
1132
## Introduction
1233

1334
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.

0 commit comments

Comments
 (0)