Skip to content

Commit

Permalink
Rebranding Unity to Unity XT in docs (#85)
Browse files Browse the repository at this point in the history
* Rebranding Unity to Unity XT in docs
  • Loading branch information
panigs7 committed May 11, 2022
1 parent 7a5eec1 commit fb14207
Show file tree
Hide file tree
Showing 17 changed files with 41 additions and 41 deletions.
4 changes: 2 additions & 2 deletions Dockerfile.podman
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ FROM driver as final

LABEL vendor="Dell Inc." \
name="csi-unity" \
summary="CSI Driver for Dell EMC Unity" \
description="CSI Driver for provisioning persistent storage from Dell EMC Unity" \
summary="CSI Driver for Dell Unity XT" \
description="CSI Driver for provisioning persistent storage from Dell Unity XT" \
version="2.3.0" \
license="Apache-2.0"
COPY csi-unity/licenses /licenses
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# CSI Driver for Dell EMC Unity XT
# CSI Driver for Dell Unity XT

[![Go Report Card](https://goreportcard.com/badge/github.com/dell/csi-unity?style=flat-square)](https://goreportcard.com/report/github.com/dell/csi-unity)
[![License](https://img.shields.io/github/license/dell/csi-unity?style=flat-square&color=blue&label=License)](https://github.com/dell/csi-unity/blob/master/LICENSE)
[![Docker](https://img.shields.io/docker/pulls/dellemc/csi-unity.svg?logo=docker&style=flat-square&label=Pulls)](https://hub.docker.com/r/dellemc/csi-unity)
[![Last Release](https://img.shields.io/github/v/release/dell/csi-unity?label=Latest&style=flat-square&logo=go)](https://github.com/dell/csi-unity/releases)

**Repository for CSI Driver for Dell EMC Unity XT**
**Repository for CSI Driver for Dell Unity XT**

## Description
CSI Driver for Unity XT is part of the [CSM (Container Storage Modules)](https://github.com/dell/csm) open-source suite of Kubernetes storage enablers for Dell EMC products. CSI Driver for Unity XT is a Container Storage Interface (CSI) driver that provides support for provisioning persistent storage using Dell EMC Unity XT storage array.
CSI Driver for Unity XT is part of the [CSM (Container Storage Modules)](https://github.com/dell/csm) open-source suite of Kubernetes storage enablers for Dell products. CSI Driver for Unity XT is a Container Storage Interface (CSI) driver that provides support for provisioning persistent storage using Dell Unity XT storage array.

It supports CSI specification version 1.5.

Expand All @@ -27,11 +27,11 @@ To run unit tests, execute `make unit-test`.

To build a podman based image, execute `make podman-build`.

You can run an integration test on a Linux system by populating the env files at `test/integration/` with values for your DellEMC Unity systems and then run `make integration-test`.
You can run an integration test on a Linux system by populating the env files at `test/integration/` with values for your Dell Unity XT systems and then run `make integration-test`.


## Runtime Dependencies
Both the Controller and the Node portions of the driver can only be run on nodes which have network connectivity to “`Unisphere for Unity`” (which is used by the driver).
Both the Controller and the Node portions of the driver can only be run on nodes which have network connectivity to “`Unisphere for Unity XT`” (which is used by the driver).

## Driver Installation
Please consult the [Installation Guide](https://dell.github.io/csm-docs/docs/csidriver/installation)
Expand Down
16 changes: 8 additions & 8 deletions dell-csi-helm-installer/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# Helm Installer for Dell EMC CSI Storage Providers
# Helm Installer for Dell CSI Storage Providers

## Description

This directory provides scripts to install, upgrade, uninstall the CSI drivers, and to verify the Kubernetes environment.
These same scripts are present in all Dell EMC Container Storage Interface ([CSI](https://github.com/container-storage-interface/spec)) drivers. This includes the drivers for:
These same scripts are present in all Dell Container Storage Interface ([CSI](https://github.com/container-storage-interface/spec)) drivers. This includes the drivers for:
* [PowerFlex](https://github.com/dell/csi-vxflexos)
* [PowerMax](https://github.com/dell/csi-powermax)
* [PowerScale](https://github.com/dell/csi-powerscale)
* [PowerStore](https://github.com/dell/csi-powerstore)
* [Unity](https://github.com/dell/csi-unity)
* [Unity XT](https://github.com/dell/csi-unity)

NOTE: This documentation uses the Unity driver as an example. If working with a different driver, substitute the name as appropriate.
NOTE: This documentation uses the Unity XT driver as an example. If working with a different driver, substitute the name as appropriate.

## Dependencies

Installing any of the Dell EMC CSI Drivers requires a few utilities to be installed on the system running the installation.
Installing any of the Dell CSI Drivers requires a few utilities to be installed on the system running the installation.

| Dependency | Usage |
| ------------- | ----- |
Expand All @@ -39,7 +39,7 @@ Most of these usages require the creation/specification of a values file. These
1. Copy a template file for the driver to a new location, naming this new file is at the users discretion. The template files are always found within the driver repo at `helm/csi-<drivername>/values.yaml`
2. Edit the file such that it contains the proper configuration settings for the specific environment. These files are yaml formatted so maintaining the file structure is important.

For example, to create a values file for the Unity driver the following steps can be executed
For example, to create a values file for the Unity XT driver the following steps can be executed
```
# cd to the installation script directory
cd dell-csi-helm-installer
Expand Down Expand Up @@ -82,7 +82,7 @@ Options:

### Upgrade A Driver

Upgrading a driver is very similar to installation. The `csi-install.sh` script is run, with the same required arguments, along with a `--upgrade` argument. For example, to upgrade the previously installed Unity driver, the following command can be supplied:
Upgrading a driver is very similar to installation. The `csi-install.sh` script is run, with the same required arguments, along with a `--upgrade` argument. For example, to upgrade the previously installed Unity XT driver, the following command can be supplied:

```
./csi-install.sh --namespace unity --values ./my-unity-settings.yaml --upgrade
Expand All @@ -109,7 +109,7 @@ Options:

### Uninstall A Driver

To uninstall a driver, the `csi-uninstall.sh` script provides a handy wrapper around the `helm` utility. The only required argument for uninstallation is the namespace name. To uninstall the Unity driver:
To uninstall a driver, the `csi-uninstall.sh` script provides a handy wrapper around the `helm` utility. The only required argument for uninstallation is the namespace name. To uninstall the Unity XT driver:

```
./csi-uninstall.sh --namespace unity
Expand Down
6 changes: 3 additions & 3 deletions dell-csi-helm-installer/csi-offline-bundle.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Offline Installation of Dell EMC CSI Storage Providers
# Offline Installation of Dell CSI Storage Providers

## Description

The `csi-offline-bundle.sh` script can be used to create a package usable for offline installation of the Dell EMC CSI Storage Providers, via either Helm
The `csi-offline-bundle.sh` script can be used to create a package usable for offline installation of the Dell CSI Storage Providers, via either Helm
or the Dell CSI Operator.

This includes the following drivers:
* [PowerFlex](https://github.com/dell/csi-vxflexos)
* [PowerMax](https://github.com/dell/csi-powermax)
* [PowerScale](https://github.com/dell/csi-powerscale)
* [PowerStore](https://github.com/dell/csi-powerstore)
* [Unity](https://github.com/dell/csi-unity)
* [Unity XT](https://github.com/dell/csi-unity)

As well as the Dell CSI Operator
* [Dell CSI Operator](https://github.com/dell/dell-csi-operator)
Expand Down
6 changes: 3 additions & 3 deletions helm/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Dell Unity Helm Chart for Kubernetes
# Dell Unity XT Helm Chart for Kubernetes

For detailed installation instructions, please check the `dell-csi-helm-installer` directory

The general outline is:

1. Satisfy the pre-requsites outlined in the Release and Installation Notes in the doc directory.

2. Create a Kubernetes secret with the Unity credentials using the template in secret.yaml.
2. Create a Kubernetes secret with the Unity XT credentials using the template in secret.yaml.

3. Make a copy of the `csi-unity/values.yaml` to the location of your choice(say csi-unity/myvalues.yaml) and fill in various installation parameters.

Expand All @@ -20,4 +20,4 @@ The general outline is:
<helmPath> - Path of the helm directory.
e.g: helm install --dry-run --values ./csi-unity/myvalues.yaml --namespace unity unity ./csi-unity

5. Or Invoke the `dell-csi-helm-installer/csi-install.sh` shell script which deploys the helm chart for CSI Unity driver.
5. Or Invoke the `dell-csi-helm-installer/csi-install.sh` shell script which deploys the helm chart for CSI Unity XT driver.
4 changes: 2 additions & 2 deletions helm/csi-unity/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ kubeVersion: ">= 1.21.0 < 1.24.0"
# WARNING: this version of the check will allow the use of alpha and beta versions, which is NOT SUPPORTED
# kubeVersion: ">= 1.21.0-0 < 1.24.0-0"
description: |
Unity CSI (Container Storage Interface) driver Kubernetes
Unity XT CSI (Container Storage Interface) driver Kubernetes
integration. This chart includes everything required to provision via CSI as
well as a Unity StorageClass.
well as a Unity XT StorageClass.
keywords:
- csi
- storage
Expand Down
2 changes: 1 addition & 1 deletion provider/provider.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package provider

/*
Copyright (c) 2019 Dell EMC Corporation
Copyright (c) 2019 Dell Corporation
All Rights Reserved
*/

Expand Down
8 changes: 4 additions & 4 deletions samples/secret/secret.yaml
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
storageArrayList:
# Array ID of Unity
# Array ID of Unity XT
# Default value: None
# Examples: "ABC00000000001"
- arrayId: "ABC00000000001"
# username for connecting to Unity Unisphere REST API server
# username for connecting to Unity XT Unisphere REST API server
# Default value: None
# Examples: "user1"
username: "user"
# password for connecting to Unity Unisphere REST API server
# password for connecting to Unity XT Unisphere REST API server
# Default value: None
# Examples: "Password"
password: "password"
# HTTPS endpoint of the Unity Unisphere REST API server
# HTTPS endpoint of the Unity XT Unisphere REST API server
# Default value: None
# Examples: "https://10.0.0.0"
endpoint: "https://1.2.3.4/"
Expand Down
4 changes: 2 additions & 2 deletions service/controller.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package service

/*
Copyright (c) 2019 Dell EMC Corporation
Copyright (c) 2019 Dell Corporation
All Rights Reserved
*/

Expand Down Expand Up @@ -160,7 +160,7 @@ func (s *service) CreateVolume(ctx context.Context, req *csi.CreateVolumeRequest
return nil, status.Errorf(codes.InvalidArgument, utils.GetMessageWithRunID(rid, "`%s` is a required parameter", keyNasServer))
}

//Add AdditionalFilesystemSize in size as Unity use this much size for metadata in filesystem
//Add AdditionalFilesystemSize in size as Unity XT use this much size for metadata in filesystem
size += AdditionalFilesystemSize

// log all parameters used in Create File System call
Expand Down
2 changes: 1 addition & 1 deletion service/csi_extension_server.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Copyright (c) 2021 Dell EMC Corporation
Copyright (c) 2021 Dell Corporation
All Rights Reserved
*/

Expand Down
2 changes: 1 addition & 1 deletion service/csi_extension_test.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Copyright (c) 2021 Dell EMC Corporation
Copyright (c) 2021 Dell Corporation
All Rights Reserved
*/

Expand Down
2 changes: 1 addition & 1 deletion service/envvars.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ package service

const (
// EnvEndpoint is the name of the environment variable used to set the
// HTTP endpoint of the Unity Gateway
// HTTP endpoint of the Unity XT Gateway
EnvEndpoint = "X_CSI_UNITY_ENDPOINT"

// EnvNodeName is the name of the enviroment variable used to set the
Expand Down
8 changes: 4 additions & 4 deletions service/utils/emcutils.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package utils

/*
Copyright (c) 2019 Dell EMC Corporation
Copyright (c) 2019 Dell Corporation
All Rights Reserved
*/

Expand All @@ -27,13 +27,13 @@ import (
"github.com/dell/gounity/types"
)

//GetVolumeResponseFromVolume Utility method to convert Unity Rest type Volume to CSI standard Volume Response
//GetVolumeResponseFromVolume Utility method to convert Unity XT Rest type Volume to CSI standard Volume Response
func GetVolumeResponseFromVolume(volume *types.Volume, arrayID, protocol string, preferredAccessibility []*csi.Topology) *csi.CreateVolumeResponse {
content := volume.VolumeContent
return getVolumeResponse(content.Name, protocol, arrayID, content.ResourceID, content.SizeTotal, preferredAccessibility)
}

//GetVolumeResponseFromFilesystem Utility method to convert Unity rest Filesystem response to CSI standard Volume Response
//GetVolumeResponseFromFilesystem Utility method to convert Unity XT rest Filesystem response to CSI standard Volume Response
func GetVolumeResponseFromFilesystem(filesystem *types.Filesystem, arrayID, protocol string, preferredAccessibility []*csi.Topology) *csi.CreateVolumeResponse {
content := filesystem.FileContent
return getVolumeResponse(content.Name, protocol, arrayID, content.ID, content.SizeTotal, preferredAccessibility)
Expand Down Expand Up @@ -172,7 +172,7 @@ func GetHostIP() ([]string, error) {
return lookupIps, nil
}

// GetSnapshotResponseFromSnapshot - Utility method to convert Unity Rest type Snapshot to CSI standard Snapshot Response
// GetSnapshotResponseFromSnapshot - Utility method to convert Unity XT Rest type Snapshot to CSI standard Snapshot Response
func GetSnapshotResponseFromSnapshot(snap *types.Snapshot, protocol, arrayID string) *csi.CreateSnapshotResponse {
content := snap.SnapshotContent
snapID := fmt.Sprintf("%s-%s-%s-%s", content.Name, protocol, arrayID, content.ResourceID)
Expand Down
2 changes: 1 addition & 1 deletion test/integration-test/integration_test.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Copyright (c) 2019 Dell EMC Corporation
Copyright (c) 2019 Dell Corporation
All Rights Reserved
*/
package integration_test
Expand Down
2 changes: 1 addition & 1 deletion test/scale-test/20volumes/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: 20volumes
version: 1.0.0
appVersion: 1.0.0
description: |
Tests CSI Unity deployments.
Tests CSI Unity XT deployments.
keywords:
- csi-unity
- storage
Expand Down
2 changes: 1 addition & 1 deletion test/unit-test/run.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/bin/sh
# This will run coverage analysis using the integration testing.
# The env.sh must point to a valid Unity Array# on this system.
# The env.sh must point to a valid Unity XT Array# on this system.

rm -f /root/go/bin/csi.sock
source ../../env.sh
Expand Down
2 changes: 1 addition & 1 deletion test/unit-test/unit_test.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Copyright (c) 2019 Dell EMC Corporation
Copyright (c) 2019 Dell Corporation
All Rights Reserved
*/
package unit_test
Expand Down

0 comments on commit fb14207

Please sign in to comment.