Skip to content

Commit

Permalink
feat: update readme and delete deprecated charts dir
Browse files Browse the repository at this point in the history
  • Loading branch information
iExalt committed Oct 29, 2024
1 parent f6b99f9 commit b7575d0
Show file tree
Hide file tree
Showing 9 changed files with 22 additions and 467 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Crusoe Energy Systems LLC

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
30 changes: 1 addition & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,4 @@ This repository defines the official Container Storage Interface (CSI) Driver fo

## Getting Started

### Prerequisites

This guide assumes that the user has already set up a Container Orchestrator (CO) on Crusoe Cloud compute.
If you have not, we would recommend beginning by deploying one of our existing solutions –
the [Crusoe Cloud RKE2 solution](https://github.com/crusoecloud/crusoe-ml-rke2) is a great place to start.

### Setting up credentials

As the CSI Driver will communicate with the Crusoe Cloud API to orchestrate storage operations, you will have to set up
credentials in your Kubernetes cluster which the driver can then use to communicate with the API. Here is a `.yaml` file
which can be modified with your credentials and applied to your cluster (using `kubectl apply -f credentials.yaml -n $CRUSOE_CSI_NAMESPACE`).

By default, the driver will use the `crusoe-api-keys` secret.

```yaml
apiVersion: v1
data:
CRUSOE_CSI_ACCESS_KEY: <base-64 encoded Crusoe Access Key>
CRUSOE_CSI_SECRET_KEY: <base-64 encoded Crusoe Secret Key>
kind: Secret
metadata:
name: crusoe-api-keys
namespace: crusoe-csi-driver

```

### Installing the Driver

We recommend using Helm to install the CSI driver.
Please follow the [Helm installation instructions](https://github.com/crusoecloud/crusoe-csi-driver-helm-charts) to install the CSI Driver.
18 changes: 0 additions & 18 deletions charts/crusoe-csi-driver/Chart.yaml

This file was deleted.

93 changes: 0 additions & 93 deletions charts/crusoe-csi-driver/templates/controller.yaml

This file was deleted.

165 changes: 0 additions & 165 deletions charts/crusoe-csi-driver/templates/controller_rbac.yaml

This file was deleted.

7 changes: 0 additions & 7 deletions charts/crusoe-csi-driver/templates/csidriver.yaml

This file was deleted.

Loading

0 comments on commit b7575d0

Please sign in to comment.