Commit Graph
34 Commits
Author SHA1 Message Date
Travis Nielsen 53ed11f15b build: remove the edgefs operator from rook
The EdgeFS operator has been deprecated for some time in Rook.
If the replacement is added back to Rook it can be completed
according to the new guidelines in the documentation.
https://rook.io/docs/rook/master/storage-providers.html

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2021-01-25 17:51:24 -07:00
Travis Nielsen 2294851ca3 build: remove the cockroachdb operator from rook
The cockroachDB operator has not had community support in Rook.
Therefore, the time has come to deprecate and remove it.
If the sources are still needed, there is always git history.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2021-01-20 17:28:58 -07:00
Travis Nielsen 193def940d docs: remove unused documentation for test clusters
Rook should not be maintaining documentation for starting a K8s cluster
such as minikube or kubeadm. For simplicity, we just link to their documentation
to help them get started. Also removed is a section in the dev guide that
nobody has used for debugging operators locally.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2020-10-09 12:23:20 -06:00
Jiffin Tony Thottan e17c1a6151 docs: mention about podman in development workflow
Rook supports building images with podman as well, mention that in documentation
Signed-off-by: Jiffin Tony Thottan <thottanjiffin@gmail.com>
2020-08-19 22:51:56 +05:30
Sébastien Han db17533435 docs: add design doc template
Rook already has a design process in place when introducing new
functionality. The only missing thing is a clear template to bring
consistency in our design documents.

This is inspired and shrunk version of
https://github.com/openshift/enhancements/tree/master/guidelines to add
some guidelines when it comes to writing a design document.

Signed-off-by: Sébastien Han <seb@redhat.com>
2020-06-10 19:05:14 +02:00
Travis Nielsen c1ee1104c8 docs: fix indentation on the commit prefixes
The list of commit prefixes in the doc were rendering on
a single line instead of as a list.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2020-05-28 17:02:12 -06:00
Sébastien Han db57455ba2 docs: update contribution guideline
Reflect the recent changes with the replacement of the commitlint bot
by the commitlint github action.

Signed-off-by: Sébastien Han <seb@redhat.com>
2020-05-28 17:36:08 +02:00
moricho 2beb731a7e go: move to gomodules
This switches Rook to use `go mod` instead of `dep` for
dependencies management.

Signed-off-by: moricho <ikeda.morito@gmail.com>
2020-03-17 16:47:53 +09:00
Travis Nielsen 9a078bf9e6 minio: remove from rook
The minio operator has not had community support nor
any updates since being added to Rook. Support is being
removed from Rook due to this lack of community interest.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2020-01-08 15:45:21 -08:00
Sébastien Han 360ff98923 documentation: improve commit structure
This commits adds more documentation on how to contribute better commit
messages.

Signed-off-by: Sébastien Han <seb@redhat.com>
2020-01-03 10:14:41 +01:00
Alexander Trost c7afa0eb43 misc: docs: unified formatting and style
This is the first phase  miscellaneous part of three phases to improve and
rework the Rook documentation for better user accessibility to the Rook
projects and  with that the storage providers.
Phase two is about automatic generation of CRD documentation and phase
three is about reworking the docs themselves and, e.g., examples for
CRDs and certain use cases.

Signed-off-by: Alexander Trost <galexrt@googlemail.com>
2019-11-01 18:13:27 +01:00
Sébastien Han cfd2a7be0b add mergify engine for backport only
This is round 2 attempting to add the mergify engine in Rook. In this
case, we only use the backporting and automerge features.

* auto backport: set a label on your PR and a backport PR will be
automatically created under the right branch
* auto backport PR merge: if the backport PR passes CI, mergify will
merge it.

Signed-off-by: Sébastien Han <seb@redhat.com>
2019-09-25 08:41:41 +02:00
Travis Nielsen 41005b53a6 Merge pull request #3456 from travisn/remove-legacy-conversion
Remove legacy Ceph CRD conversion from v1beta1 to v1
2019-07-17 11:52:41 -06:00
travisn 9e073857c5 ceph: remove legacy conversion from v1beta1 to v1
In the 0.9 release rook converted the v1beta1 CRD resources
to v1 resources. This conversion code is no longer necessary
as we will be using v1 resources going forward.
The code paths will not be triggered anymore, thus
removing the dead code.

Signed-off-by: travisn <tnielsen@redhat.com>
2019-07-15 16:58:37 -06:00
Sébastien Han b25b3c68c8 contrib: add an helper script to perform backports
Run the script like this:

./contrib/backport_to_stable_branch.sh STABLE_BRANCH_NAME COMMIT_SHA1 BACKPORT_BRANCH_NAME

Signed-off-by: Sébastien Han <seb@redhat.com>
2019-07-12 09:15:07 +02:00
Guy Margalit 2ce2382676 Refactor operator context init and allow to run local
Signed-off-by: Guy Margalit <guymguym@gmail.com>
Co-Authored-By: Sébastien Han <seb@redhat.com>
Co-Authored-By: Travis Nielsen <tnielsen@redhat.com>

This change is meant to allow running operators locally on a developer machine.
The idea is to allow faster development cycles by reducing the time and complexity of building -> deploying -> debugging on cluster.

For operators that rely only on kubernetes API this works easily - see cockroachdb and minio examples in development-flow doc.

The change includes:

- rook.NewContext() - Refactored to remove repeating initialization code that was copy-pasted in most of the operators in order to create the clusterd.Context and the Clientsets. Also it detects the mode of working in-cluster vs external and sets up the external mode with standard user config (~/.kube/config) and a job executor.
- rook.GetOperatorImage() - Refactor this repeating code in many operators to detect the operator pod image. Also added a global flag --operator-image that developers can use to override this when running locally.
- rook.TerminateOnError() - Added a convenient function.
2019-06-19 20:47:55 +03:00
travisn f0117150f3 docs: consistent dev environment
Signed-off-by: travisn <tnielsen@redhat.com>
2019-02-21 12:25:01 -07:00
Dmitry Yusupov 90ad28475c add 00 to all the weights in *.md files
Signed-off-by: Dmitry Yusupov <dmitry@nexenta.com>
2019-02-04 09:46:00 -08:00
travisn 0524084592 docs: table of contents with a storage provider organization
Signed-off-by: travisn <tnielsen@redhat.com>
2018-12-08 08:07:03 -07:00
travisn 57d58760c2 docs: minor updates for the 0.9 release
Signed-off-by: travisn <tnielsen@redhat.com>
2018-12-07 22:50:33 -07:00
Alexander Trost 097f640bbb doc: rename monitoring doc for Ceph
doc: move Ceph mon example files to ceph example subfolder

Signed-off-by: Alexander Trost <galexrt@googlemail.com>
2018-12-07 19:33:27 +01:00
rohan47 3aef6fc213 [Documentation] Added source code layout
Signed-off-by: rohan47 <rohanrgupta1996@gmail.com>
2018-11-05 20:50:23 +05:30
Blaine Gardner fe5fb394c7 Fix spellcheck and trailing space/newline issues
Fix some basic spellcheck errors. Also remove trailing spaces and make
sure files have a newline (my editor does automatically).

Signed-off-by: Blaine Gardner <blaine.gardner@suse.com>
2018-07-26 11:36:09 -06:00
travisn 0854cbaf55 docs: clarifications for the 0.8 release
Signed-off-by: travisn <tnielsen@redhat.com>
2018-07-13 14:29:57 -06:00
Jared Watts 8c008e96d9 docs: update contribution flow to clarify design document process
Signed-off-by: Jared Watts <jbw976@gmail.com>
2018-03-29 17:27:54 -07:00
Jared Watts c35754ece8 Add golang 1.10 to supported list, minor updates to dev flow instructions
Signed-off-by: Jared Watts <jbw976@gmail.com>
2018-02-26 14:41:28 -08:00
Sébastien Han 3c6fa79518 doc: add doc for multi-node setup and dev workflow
This commit adds instructions to develop on a multi-node deployment,
which is somehow similar to a production setup.
It also proposes a development workflow approach to
write/build/test/ship
code to Rook.

Signed-off-by: Sébastien Han <seb@redhat.com>
2018-02-21 17:45:49 +01:00
Travis Nielsen 6a1a1c31ad docs: helm chart install and other clarifications 2018-01-19 16:47:57 -08:00
Travis Nielsen 873751349a docs: update the table of contents 2018-01-12 16:55:34 -08:00
Jared Watts a36780b84a docs: steps for backporting fixes to release branches 2017-12-15 10:13:01 -08:00
Jared Watts 1616167422 docs: user guide for upgrading a Rook cluster 2017-09-11 08:38:33 -07:00
Ian Lovett 7d3a4029cd docs: polish docs for consistent and heirarchical title formatting, add spacing in raw md for readability 2017-08-07 12:20:09 -07:00
Ian Lovett 7b2ade4af5 add front matter, add landing page, fix broken link to docs site 2017-08-04 14:19:44 -07:00
aramisjohnson 8aebb76478 Add development workflow process 2017-05-08 14:54:06 -07:00