ceph / ceph/ceph-csi-operator

Publish example CRs for manifest installs

Open
#487 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
63
Forks
59
Avg merge
1d 19h
Merged PRs (30d)
19

Description

# Describe the feature you'd like to have #

Example manifests should be provided that show how to configure the Ceph CSI operator, for non-helm users. For example, Rook users have the [examples folder](https://github.com/rook/rook/tree/master/deploy/examples) that shows common different ways to configure the CRs. Currently, all Rook docs can point to in this repo is the helm examples, which is a different format that is not useful for non-helm users.

## Who is the end user and what is the use case where this feature will be valuable? ##

Any non-helm user should be able to configure Ceph CSI operator CRs, and examples will be very helpful to get them started, even with defaults.

# How will we know we have a good solution? (acceptance criteria) #

Rook users converting to Ceph CSI operator in Rook v1.20 will have clear examples on the conversion, beyond the documentation that Rook has published [here](https://rook.io/docs/rook/latest/Storage-Configuration/Ceph-CSI/csi-configuration/). The Rook documentation should point to more detailed examples in this repo, so Rook does not need to maintain the examples in its repo.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.