Commit Graph
32 Commits
Author SHA1 Message Date
subhamkrai 0c115927e1 build: remove go1.20 support and default to go1.21
Signed-off-by: subhamkrai <srai@redhat.com>
2023-12-19 11:55:03 +05:30
Redouane Kachach b9501bdddb test: adding support for multi-rook clusters creation
This change introduce a new argument -p to specify the minikube
profile for the new cluster. This way we can have multiple rook
clusters running on the same machine.

Signed-off-by: Redouane Kachach <rkachach@redhat.com>
2023-11-08 13:29:46 +01:00
Redouane Kachach 73b7e649d7 test: adding a script to simplify test cluster creation
Signed-off-by: Redouane Kachach <rkachach@redhat.com>
2023-10-30 16:48:49 +01:00
Blaine Gardner 1d830207a2 docs: update "synk" -> "snyk" spelling
Update some old typos that say "synk" instead of "snyk".
out of sync. This should fix the top-level README.md to use the latest
snyk security scan badge -- as opposed to only referring to the last one
that used the misspelled file from about a month ago.

Signed-off-by: Blaine Gardner <blaine.gardner@ibm.com>
2023-10-24 09:09:38 -06:00
Redouane Kachach e32ece275c docs: fixing typos
Signed-off-by: Redouane Kachach <rkachach@redhat.com>
2023-10-05 20:17:15 +02:00
Redouane Kachach 5f4fae4f3b docs: improving minikube setup documentation
Adding some detailed instructions on how to use the local
built Rook image on minikube cluster

Signed-off-by: Redouane Kachach <rkachach@redhat.com>
2023-10-04 10:51:12 +02:00
subhamkrai 47c0038136 docs: krew is wrong word use kubectl instead
krew is itself a plugin and it is wrong wording
to use krew plugin intead it should be kubectl
pluging.

Signed-off-by: subhamkrai <srai@redhat.com>
2023-09-27 20:26:14 +05:30
Michael AdamandTravis Nielsen c8c97bb8a1 docs: mention make check-helm-docs and make docs in the contributing guide
Signed-off-by: Michael Adam <obnox@samba.org>
Co-authored-by: : Michael Adam <obnox@samba.org>
signed-off-by: Travis Nielsen <tnielsen@redhat.com>
Co-authored-by: Travis Nielsen <tnielsen@redhat.com>
2023-09-01 18:17:02 +02:00
subhamkrai a223b6777b ci: enable tmate when in debug mode
we don't want to wait for extra 10min once the ci passed,
so we'll add a check if `debug-ci` label is added or debug runner
is triggered from UI then only start tmate. Also, updaing the
development doc and rook test doc.

Signed-off-by: subhamkrai <srai@redhat.com>
2023-08-26 11:14:08 +05:30
Javier b16f062af0 docs: move how to run tests instructions to contributing
rename and move tests/README.md to
Documentation/Contributing/rook-test-framework.md in order to make it
part of the contributing section

Signed-off-by: Javier <sjavierlopez@gmail.com>
2023-08-17 10:13:39 -06:00
travisn 05bebc1615 ci: require go 1.20 in the builds
To update to the latest go modules we need to restrict golang
support to 1.20 for now.

Signed-off-by: travisn <tnielsen@redhat.com>
2023-06-22 16:37:10 -06:00
Blaine Gardner a57d972aa1 docs: suggest qeumu driver for minikube on apple silicon
Apple silicon does not support hyperkit, and virtualbox does not support
Apple silicon (yet). Suggest the QEMU driver for development on MacOS
with Apple silicon.

Signed-off-by: Blaine Gardner <blaine.gardner@redhat.com>
2023-06-14 11:08:11 -06:00
travisn e631cf6e59 docs: clarify instructions on submitting a PR
The unit tests are not necessary if a PR is being opened for
documentation or other non-code changes, so we clarify the
instructions.

Signed-off-by: travisn <tnielsen@redhat.com>
2023-06-02 16:18:45 -06:00
travisn 9f2ecedf7b docs: dev guide review updates
The dev guide had some outdated info that is now updated,
as well as some rewording for consistency and improved
writing.

Signed-off-by: travisn <tnielsen@redhat.com>
2023-05-11 12:20:46 -06:00
Sheetal Pamecha 422b037cab docs: correct link for helm.sh file
Signed-off-by: Sheetal Pamecha <spamecha@redhat.com>
2023-05-08 09:58:48 +05:30
Juan Miguel Olmo Martínez b21f71f177 docs: debug and test ceph manager modules
testing changes and debugging issues in Ceph manager modules

Signed-off-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
2023-03-09 16:45:21 +01:00
parth-gr b81ee215a7 build: update golang version to v1.19
Updated the go mod and ci to use gov1.19 as
minimum and removed support for go1.18

Closes: https://github.com/rook/rook/issues/11681
Signed-off-by: parth-gr <paarora@redhat.com>
2023-02-17 18:39:05 +05:30
Redouane Kachach bf15617b7f docs: fixing build instructions
Adding instructions to fetch the tags as they are used during
the build process. The current instructions only require the
user to clone the project which results in build errors later
on.

Closes: https://github.com/rook/rook/issues/11619
Signed-off-by: Redouane Kachach <rkachach@redhat.com>
2023-02-07 14:46:15 +01:00
Zuhair 792a261ca9 docs: auto generate helm chart docs using helm-docs
Signed-off-by: Zuhair AlSader <zuhair@koor.tech>
2022-12-02 17:08:50 -05:00
Travis Nielsen b79d9022a4 docs: clarify in docs and readme that rook focuses on ceph
Rook has for quite some time only been focused on the Ceph
operator. Maintainers have only been focused on Ceph, and
the community has likewise been focused on Ceph. Now the docs
are updated to clarify that Ceph storage is the focus and
there are no plans for the project to support other storage
providers.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2022-11-14 14:37:46 -07:00
Yashasvi Chaurasia 05e7ddc4cb docs: updated note syntax in markdown files
The Note label is updated in several places in the docs for improved rendering.
Multiple markdown files have been updated.

Closes: #10458

Signed-off-by: Yashasvi Chaurasia <yashasvi12977@gmail.com>
2022-10-20 20:04:01 +05:30
Tarun Gupta Akirala 6c2335b37a docs: fix notes in contributing docs
Signed-off-by: Tarun Gupta Akirala <takirala@users.noreply.github.com>
2022-10-04 17:18:33 -07:00
Alexander Trost aade41a88f docs: improve documentation about documentation building
Signed-off-by: Alexander Trost <galexrt@googlemail.com>
2022-08-30 15:46:21 +02:00
Travis Nielsen 49ca309622 build: only support go 1.18 with the latest modules
The modules are only compatible with go 1.18.
Remove support for go 1.17.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2022-08-11 12:31:50 -06:00
Alexander Trost 9872b3f7d6 docs: add ci configuration page
This page contains initial information on Rook's CI setup, such as
environment variables.

Signed-off-by: Alexander Trost <galexrt@googlemail.com>
2022-08-11 18:50:06 +02:00
Alexander Trost fe2000e6d8 docs: rename Rook-Ceph to Rook Ceph
Signed-off-by: Alexander Trost <galexrt@googlemail.com>
2022-08-11 14:58:57 +02:00
subhamkrai 2cb3409e39 docs: add section to update GOPROXY
In linux environment, when go is installed using
`dnf/yum/apt` or other pacakge installer. In this case we
get error when we do `make build` because of GOPROXY.
So, we need to update the GOPROXY with `export GOPROXY=https://proxy.golang.org,direct`
in `.bashrc` file

Signed-off-by: subhamkrai <srai@redhat.com>
2022-07-28 20:57:56 +05:30
parth-gr 2ba7237c98 ci: add ci bot for auto assign issue
Now users can auto-assign issues by commenting
/assign on the issue topic

Closes: https://github.com/rook/rook/issues/10492
Signed-off-by: parth-gr <paarora@redhat.com>
2022-07-14 11:22:28 +05:30
Travis Nielsen 832cebc4c1 Merge pull request #10349 from subhamkrai/doc-latest-change
docs: update doc path according to new doc change
2022-06-01 09:25:44 -06:00
subhamkrai 49a35a9311 docs: update doc path according to new doc change
we need to update the referred doc path
according to our latest doc change.

Signed-off-by: subhamkrai <srai@redhat.com>
2022-06-01 20:17:44 +05:30
Alexander Trost 45851dc9e5 docs: add vscode recommended extensions and settings
This adds vscode json files to recommend extensions and set some
settings which are used to make the development easier.

Signed-off-by: Alexander Trost <galexrt@googlemail.com>
2022-05-27 23:57:47 +02:00
Alexander Trost 74431443e3 docs: use mkdocs and restructure docs
Signed-off-by: Alexander Trost <galexrt@googlemail.com>
2022-05-18 16:06:22 +02:00