Skip to content

Latest commit

 

History

History
130 lines (98 loc) · 10.4 KB

README.md

File metadata and controls

130 lines (98 loc) · 10.4 KB
Raw

Nutanix COSI driver for provisioning and consuming Nutanix object storage in Kubernetes

Nutanix cosi driver is Nutanix specific component that receives requests from the COSI sidecar and calls the appropriate APIs to create buckets, manage their lifecycle and manage access to them.

COSI driver supports these operations:

  1. Creation/Deletion of buckets
  2. Granting/Revoking bucket access to individual users

Pre-requisites

  1. Install Helm v3.0.0.
  2. Install a Kubernetes cluster.

Installation and running on the cluster

Deploy the cosi-driver on the cluster:

Clone this repo, get into the charts directory and run the below command:

helm install cosi-driver -n cosi-driver-nutanix --create-namespace .

Uninstalling the chart

To uninstall/delete the cosi-driver-nutanix chart:

helm uninstall cosi-driver -n cosi-driver-nutanix

NOTE: The CRDs installed via helm will not be deleted from the above command. Those have to manually deleted.

Upgrading the chart

Upgrade the cosi-driver-nutanix chart to a particular version can be achieved via the helm upgrade command with the following syntax: helm upgrade [RELEASE] [CHART] [flags]

Example:

helm upgrade cosi-driver -n cosi-driver-nutanix .

To know more about the various flag options used with upgrade command check out the helm_upgrade official document.

Configuration

The following table lists the configurable parameters of the cosi-driver-nutanix chart and their default values.

Parameter Description Default
nameOverride To override the name of the cosi-driver chart ""
fullnameOverride To override the full name of the cosi-driver chart ""
image.registry Image registry for cosi-driver-nutanix sidecar ghcr.io/
image.repository Image repository for cosi-driver-nutanix sidecar nutanix-cloud-native/cosi-driver-nutanix
image.tag Image tag for cosi-driver-nutanix sidecar ""
image.pullPolicy Image registry for cosi-driver-nutanix sidecar IfNotPresent
secret.enabled Enables K8s secret deployment for Nutanix Object Store true
secret.endpoint Nutanix Object Store instance endpoint ""
secret.access_key Admin IAM Access key to be used for Nutanix Objects ""
secret.secret_key Admin IAM Secret key to be used for Nutanix Objects ""
secret.pc_ip PC ip ""
secret.pc_port PC port ""
secret.pc_username PC username ""
secret.pc_password PC password ""
secret.account_name Account Name is a displayName identifier Prefix for Nutanix "ntnx-cosi-iam-user"
cosiController.logLevel Verbosity of logs for COSI central controller deployment 5
cosiController.image.registery Image registry for COSI central controller deployment gcr.io/
cosiController.image.repository Image repository for COSI central controller deployment k8s-staging-sig-storage/objectstorage-controller
cosiController.image.tag Image tag for COSI central controller deployment v20221027-v0.1.1-8-g300019f
cosiController.image.pullPolicy Image pull policy for COSI central controller deployment Always
objectstorageProvisionerSidecar.logLevel Verbosity of logs for COSI sidecar 5
objectstorageProvisionerSidecar.image.registery Image registry for COSI sidecar gcr.io/
objectstorageProvisionerSidecar.image.repository Image repository for COSI sidecar k8s-staging-sig-storage/objectstorage-sidecar/objectstorage-sidecar@sha256
objectstorageProvisionerSidecar.image.tag Image tag for COSI sidecar 589c0ad4ef5d0855fe487440e634d01315bc3d883f91c44cb72577ea6e12c890
objectstorageProvisionerSidecar.image.pullPolicy Image pull policy for COSI sidecar Always

Configuration examples:

Install the driver in the cosi-driver-nutanix namespace (add the --create-namespace flag if the namespace does not exist):

helm install cosi-driver -n cosi-driver-nutanix .

Individual configurations can be set by using --set key=value[,key=value] like:

helm install cosi-driver -n cosi-driver-nutanix . --set cosiController.logLevel=2

In the above command cosiController.logLevel refers to one of the variables defined in the values.yaml file.

All the options can also be specified in a values.yaml file:

helm install cosi-driver -n cosi-driver-nutanix -f values.yaml .

Steps to update the Nutanix Object store details while installing COSI:

  1. Open Prism Central UI in any browser and go the objects page. In the below screenshot, already an object store called cosi is deployed which is ready for use. On the right side of the object store, you will see the objects Public IPs which you can use as the endpoint in the format: http:<objects public ip>:80.
Screenshot 2023-08-10 at 4 31 41 PM
  1. On the side navigation bar click the Access Keys tab and then click on Add People.
Screenshot 2023-08-10 at 4 41 41 PM
  1. Add a new email address and name and click Next.
Screenshot 2023-08-10 at 4 42 41 PM
  1. Now click the Generate Keys button.
Screenshot 2023-08-10 at 4 43 00 PM
  1. After the keys are generated download the generated keys.
Screenshot 2023-08-10 at 4 43 16 PM
  1. Now, in the Access Key tab you will be able to see the person you just added.
Screenshot 2023-08-10 at 4 43 52 PM
  1. The keys file that you downloaded will be a text file which will contain the Access Key and Secret Key that you need to update in helm values.

Keep the endpoint details collected in step#1, the keys details mentioned in step#7 and Nutanix Prism-Central(PC) details in the format <prism-ip>:<prism-port>:<user>:<password> handy.

To update the secret details use the below helm command to deploy Nutanix cosi driver:

helm install cosi-driver -n cosi-driver-nutanix . --set secret.enabled=true --set secret.endpoint=<object-store-endpoint> secret.access_key=<object-store-access-key> --set secret.secret_key=<object-store-secret-key>  --set secret.pc_secret=<nutanix-pc-details>

Support

Community Plus

This code is developed in the open with input from the community through issues and PRs. A Nutanix engineering team serves as the maintainer. Documentation is available in the project repository.

Issues and enhancement requests can be submitted in the Issues tab of this repository. Please search for and review the existing open issues before submitting a new issue.

License

Copyright 2021-2022 Nutanix, Inc.

The project is released under version 2.0 of the Apache license.