Skip to content

Commit

Permalink
add csctl installation docs
Browse files Browse the repository at this point in the history
Signed-off-by: kranurag7 <[email protected]>
  • Loading branch information
kranurag7 authored and jschoone committed Jun 3, 2024
1 parent 98772be commit 19b87a0
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 19b87a0

Please sign in to comment.