Skip to content

NO-JIRA: List all supported operators in README #277

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

Merged
openshift-merge-bot merged 2 commits into from
Sep 30, 2024
Merged

NO-JIRA: List all supported operators in README #277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b4ea179
make: Remove trailing slash
stephenfin Aug 26, 2024
bbff07a
README: List all supported operators
stephenfin Aug 26, 2024
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
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
all: build
.PHONY: all

GO_BUILD_BINDIR=bin/
GO_BUILD_BINDIR=bin

# Include the library makefile
include $(addprefix ./vendor/github.com/openshift/build-machinery-go/make/, \
Expand Down
20 changes: 14 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,21 @@
# CSI driver operators

This repository contains code for CSI driver operators that are part of OpenShift payload and few optional ones that are installed by Operator Lifecycle Manager (OLM).
This repository contains code for CSI driver operators that are part of
OpenShift payload and few optional ones that are installed by Operator
Lifecycle Manager (OLM).

## Operators

* aws-ebs-csi-driver-operator
* aws-efs-csi-driver-operator
* azure-disk-csi-driver-operator
* azure-file-csi-driver-operator
* smb-csi-driver-operator

## Automatic generation of CSI driver assets

As part of the repository, there is generator of CSI driver YAML files in `cmd/generator`.
As part of the repository, there is generator of CSI driver YAML files in
`cmd/generator`.

### Usage

Expand All @@ -18,9 +25,9 @@ As part of the repository, there is generator of CSI driver YAML files in `cmd/g

Some documentation is available via godoc. Usage:

```
$ godoc &
$ firefox localost:6060/pkg/github.com/openshift/csi-operator/
```shell
godoc &
firefox localost:6060/pkg/github.com/openshift/csi-operator/
```

Good starting points are `pkg/generator` and `pkg/generated-assets`.
Expand All @@ -29,7 +36,8 @@ Good starting points are `pkg/generator` and `pkg/generated-assets`.

### AWS EBS CSI driver operator

Before running the operator manually, you must remove the operator installed by CSO/CVO
Before running the operator manually, you must remove the operator installed by
CSO/CVO

```shell
# Scale down CVO and CSO
Expand Down