Skip to content

Commit

Permalink
Rename chart
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidMarchant committed Jan 19, 2022
1 parent 55c0c73 commit 12d5f69
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 26 deletions.
7 changes: 4 additions & 3 deletions charts/ondat-operator/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
apiVersion: v2
appVersion: "v2.5.0"
description: Cloud Native storage for containers
name: storageos-operator
name: ondat-operator
version: 0.5.0
keywords:
- storage
- block-storage
- volume
- operator
home: https://storageos.com
home: https://ondat.io
# TODO: change
icon: https://docs.storageos.com/images/logo-helm.svg
sources:
- https://github.com/storageos
- https://github.com/ondat
maintainers:
- name: DavidMarchant
email: [email protected]
Expand Down
2 changes: 1 addition & 1 deletion charts/ondat-operator/LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020 StorageOS
Copyright (c) 2022 Ondat

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
35 changes: 19 additions & 16 deletions charts/ondat-operator/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# StorageOS Operator Helm Chart
# Ondat Operator Helm Chart

> **Note**: This chart requires Helm 3 and defaults to StorageOS v2. To upgrade
> from a previous chart or from StorageOS version 1.x to 2.x, please contact
Expand All @@ -12,7 +12,7 @@ message queues, and other mission-critical stateful solutions. StorageOS
Project edition also offers ReadWriteMany volumes that are concurrently
accessible by multiple applications.

The StorageOS Operator installs and manages StorageOS within a cluster. Cluster
The Ondat Operator installs and manages StorageOS within a cluster. Cluster
nodes may contribute local or attached disk-based storage into a distributed
pool, which is then available to all cluster members via a global namespace.

Expand All @@ -25,7 +25,7 @@ custom kernel modules.

After StorageOS is installed, please register for a free personal license to
enable 1TiB of capacity and HA with synchronous replication by following the
instructions [here](https://docs.storageos.com/docs/operations/licensing). For
instructions [here](https://docs.ondat.io/docs/operations/licensing). For
additional capacity, features and support plans contact [email protected].

## Highlighted Features
Expand Down Expand Up @@ -61,7 +61,7 @@ no legacy restrictions to give enterprises working with cloud native workloads
a scalable storage platform with no compromise on performance, availability or
security. For additional information, visit www.ondat.io.

This chart installs a StorageOS Cluster Operator which helps deploy and
This chart installs a Ondat Cluster Operator which helps deploy and
configure a StorageOS cluster on kubernetes.

## Prerequisites
Expand All @@ -72,29 +72,32 @@ configure a StorageOS cluster on kubernetes.
- Etcd cluster

Refer to the [StorageOS prerequisites
docs](https://docs.storageos.com/docs/prerequisites/) for more information.
docs](https://docs.ondat.io/docs/prerequisites/) for more information.

## Installing the chart

<!-- TODO: which URL should I use to refrence the chart? The below also
works at time of writing -->

```console
# Add storageos charts repo.
$ helm repo add storageos https://charts.storageos.com
# Add ondat charts repo.
$ helm repo add ondat https://charts.ondat.io
# Install the chart in a namespace.
$ kubectl create namespace storageos-operator
$ helm install my-storageos storageos/storageos-operator \
--namespace storageos-operator \
$ kubectl create namespace ondat-operator
$ helm install my-ondat ondat/ondat-operator \
--namespace ondat-operator \
--set cluster.kvBackend.address=<etcd-node-ip>:2379 \
--set cluster.admin.password=<password>
```

This will install the StorageOS cluster operator in `storageos-operator`
This will install the Ondat cluster operator in `ondat-operator`
namespace and deploys StorageOS with a minimal configuration. Etcd address
(kvBackend) and admin password are mandatory values to install the chart.

The password must be at least 8 characters long and the default username is
`storageos`, which can be changed like the above values. Find more information
about installing etcd in our [etcd
docs](https://docs.storageos.com/docs/prerequisites/etcd/).
docs](https://docs.ondat.io/docs/prerequisites/etcd/).

To avoid passing the password as a flag, install the chart with the values file.
Create a values.yaml file and pass the file name with `--values` flag.
Expand All @@ -108,8 +111,8 @@ cluster:
```
```console
$ helm install storageos/storageos-operator \
--namespace storageos-operator \
$ helm install ondat/ondat-operator \
--namespace ondat-operator \
--values <values-file>
```
> **Tip**: List all releases using `helm list -A`
Expand Down Expand Up @@ -164,7 +167,7 @@ spec:
```

<!--- TODO: replace this when an equivalent specification exsists for the new
operator, ticket has been created -->
operator, ticket has been created. Also replace in app-readme -->
Learn more about advanced configuration options
[here](https://github.com/storageos/cluster-operator/blob/master/README.md#storageoscluster-resource-configuration).

Expand Down Expand Up @@ -258,7 +261,7 @@ would delete the custom resource and the cluster.
To uninstall/delete the storageos cluster operator deployment:

```console
$ helm uninstall <release-name> --namespace storageos-operator
$ helm uninstall <release-name> --namespace ondat-operator
```

If the chart was installed with cluster auto-provisioning enabled, chart
Expand Down
10 changes: 5 additions & 5 deletions charts/ondat-operator/app-readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# StorageOS Operator
# Ondat Operator

StorageOS is a cloud native, software-defined storage platform that transforms
commodity server or cloud based disk capacity into enterprise-class persistent
Expand All @@ -8,7 +8,7 @@ message queues, and other mission-critical stateful solutions. StorageOS
Project edition also offers ReadWriteMany volumes that are concurrently
accessible by multiple applications.

The StorageOS Operator installs and manages StorageOS within a cluster. Cluster
The Ondat Operator installs and manages StorageOS within a cluster. Cluster
nodes may contribute local or attached disk-based storage into a distributed
pool, which is then available to all cluster members via a global namespace.

Expand All @@ -22,7 +22,7 @@ custom kernel modules.

After StorageOS is installed, please register for a free personal license to
enable 1TiB of capacity and HA with synchronous replication by following the
instructions [here](https://docs.storageos.com/docs/operations/licensing). For
instructions [here](https://docs.ondat.io/docs/operations/licensing). For
additional capacity, features and support plans contact [email protected].

## Highlighted Features
Expand Down Expand Up @@ -56,13 +56,13 @@ StorageOS is a software-defined cloud native storage platform delivering
persistent storage for Kubernetes. StorageOS is built from the ground-up with
no legacy restrictions to give enterprises working with cloud native workloads
a scalable storage platform with no compromise on performance, availability or
security. For additional information, visit www.storageos.com.
security. For additional information, visit www.ondat.io.

## Installation

StorageOS requires an etcd cluster in order to function. Find out more about
setting up an etcd cluster in our [etcd
docs](https://docs.storageos.com/docs/prerequisites/etcd/).
docs](https://docs.ondat.io/docs/prerequisites/etcd/).

By default, a minimal configuration of StorageOS is installed. To set advanced
configurations, disable the default installation of the StorageOS cluster
Expand Down
2 changes: 1 addition & 1 deletion charts/ondat-operator/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This is a YAML-formatted file.
# Declare variables to be passed into your templates.

name: storageos-operator
name: ondat-operator

k8sDistro: default

Expand Down

0 comments on commit 12d5f69

Please sign in to comment.