Skip to content

Issue47: Updated installation part in readme. #49

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

Open
SyedMurtazaHassan46 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Issue47: Updated installation part in readme. #49

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
28 changes: 19 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,27 +63,37 @@ First, set up AWS secrets manager on your AWS account:

### 📥 Install XkOps

1. Clone the repository and navigate to the cloned repo:
1. Install Helm on your system:
Refer to this guide for instructions on how to install Helm.

2. Create values.yaml file and input your specific value for each key.

- The values.yaml file in Helm provides a structured approach for users to customize configuration parameters essential for deploying Helm charts.

- You need to provide following in your values.yml file:

REGION:
CLUSTER_NAME:
SLACK_CHANNEL_NAME:

3. Add the XkOps remote repository into your local Helm registry


```commandline
git clone https://github.com/XgridInc/xkops.git && cd xkops
helm repo add xkops https://xgridinc.github.io/xkops/charts/stable
```

2. Update values.yaml file and input your specific value for each key.
3. Install XkOps using Helm:
4. Install XkOps using Helm:

```commandline
helm install xkops ./helm -f values.yml
helm install my-xkops xkops/xkops -f values.yaml
```

4. After successful installation, obtain the link of the XkOps frontend service to access the dashboard:
5. After successful installation, obtain the link of the XkOps frontend service to access the dashboard:

```commandline
kubectl get svc -n xkops
```

5. Create an unclaimed volume in your cluster and delete it using the delete button on the dashboard. You can verify the volume deletion action both from the dashboard and the cluster.

## 🚧 Road Map

To report a new feature request or to report any issues or bugs encountered while using XkOps, please feel free to [create a new issue](https://github.com/XgridInc/xkops/issues "create a new issue") on the project's GitHub repository or contact the development team via [Slack Channel](https://join.slack.com/t/xkopscommunity/shared_invite/zt-1u8xzjvvq-B52TJ2XE861v3KDvpA9UVg). The following features are currently either in progress or planned:
Expand Down