Docs #77

Akrog · 2022-11-22T13:07:51Z

This PR includes a series of patches to improve the cinder operator documentation to include:

Getting started guide
Contributor guidelines
Using external dependencies
Debugging guide

Akrog · 2022-11-22T14:51:14Z

I need to update these commits for the new CRD from openstack-k8s-operators/openstack-operator#53

dprince · 2022-11-23T12:49:45Z

hack/dev/openstack-ceph.yaml

@@ -0,0 +1,114 @@
+apiVersion: core.openstack.org/v1beta1


only negative about having an example like this within the cinder-operator is it is likely to become stale quickly. Would this specific example be better suited within the openstack-operator itself?

My idea of having this example here for now was to promote cinder folks always deploy using the openstack-operator and for now to make sure we always keep it updated.

In the near future (once we merge the extraVolumes stuff) I'm think of adding it like you suggest to the openstack-operator itself and make the openstack_deploy target in install_yamls' Makefile to do the ceph toy cluster deployment automatically and use it in Cinder and Glance, that way we get something similar to what devstack does, a working OpenStack deployment with Ceph.

Maybe we can merge PR77 with openstack-ceph.yaml and then remove it once a copy of it is in the openstack-operator.

dprince · 2022-11-23T12:53:20Z

Nice doc effort here. Should be helpful to onboard folks to cinder-operator. I do think that over time we might promote some of this stuff to openstack-operator or at a higher level as it could apply to all openstack operators. But that can come in time.

Akrog · 2022-11-23T13:05:57Z

You read my mind. :-)
First get something here and then see what things are common and can be moved to the docs repo.

Akrog · 2022-11-25T14:22:32Z

Do not merge, I want to update it to use workspaces once we merge #79

Akrog · 2022-11-25T14:22:39Z

/hold

openshift-ci · 2022-12-01T15:47:28Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Akrog

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [Akrog]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

This patch adds a series of files to the `hack` directory to facilitate the development. These files include: - Helper functions - Script to deploy a local toy Ceph cluster - Script to create the LVM loopback device inside the OpenShift VM - OpenStack and Cinder client installation and configuration files - Manifest for OpenStack with Cinder and Glance using local Ceph cluster

This patch adds some scripts to facilitate the testing of PRs with dependencies. Four scripts are introduced: - hack/cleandeps.sh: Cleans up contents of go.work - hack/showdeps.py: Show the dependencies of a PR based on its commit messages contents (Depends-On:) - hack/setdeps.py: Replaces modules in the go workspace with local directories, PRs, remote branches, etc. - hack/checkout_pr.sh: Leverages the other scripts to do the checkout of a PR and replace the dependencies as needed.

This patch updates the README.md file to be a bit more detailed in how we can get a working deployment with Ceph as a backend for Cinder and Glance.

This patch adds some documentations to help new contributors get started. It is not complete, since it doesn't explain how to work with merged and unmerged dependencies with other operators and lib-common, but it should serve as a good start.

This patch introduces a couple of guides on how to do dependencies in the cinder-operator to explain simple and circular references for both running the operator locally and building the operator.

This patch introduces a simple debug guide to help new developers.

tosky · 2022-12-06T15:24:36Z

README.md

+- *If possible don't run things in your own machine to avoid the risk of
+  affecting the development of your other projects.*
+
+Here we'll explain how to get a functiona OpenShift deployment running inside a


nit: functional

tosky · 2022-12-06T15:26:06Z

README.md

+### OpenShift cluster
+
+There are many ways get an OpenShift cluster, and our recommendation for the
+time being is to use [OpenShift Local](https://access.redhat.com/documentation/en-us/red_hat_openshift_local/2.5/html/getting_started_guide/index)


the last version of OpenShift Local is 2.11

tosky · 2022-12-06T16:05:11Z

docs/dev/local-dependencies.md

+Alternatively we can use the `hack/setdeps.py` to do all that for us:
+
+```
+hack/setdeps.py lib-common=88


looking at he next like it seems 88 is the pull request ID, could it be explicitly mention?

This patch makes changes to the getting started scripts and manifest to adapt to the new extraVol changes.

fultonj · 2022-12-19T22:05:24Z

README.md

-### How it works
-This project aims to follow the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/)
+```sh
+source ~/cinder-operator/hack/dev/osp-clients-cfg.sh


This works but maybe in the future it can be replaced by the client pod.

fultonj · 2022-12-19T22:35:53Z

CONTRIBUTING.md

+
+The cinder-operator project will not squash all pull request commits into a
+single commit but will look to preserve all submitted individual commits
+instead using a merge strategy instead.  This means that we can have both


Please remove one of the 'instead'.

CONTRIBUTING.md

fultonj

This is really helpful. Thank you Gorka. I think these docs help a lot and aside from a few typos it would be nice to see them merged in the project.

fultonj · 2022-12-19T22:49:21Z

docs/dev/local.md

+only have a cinder-operator pod running, but also the different cinder
+services.
+
+Since we have everything running we need to uninstalling both the


s/uninstalling/uninstall

bogdando · 2023-01-12T14:27:36Z

docs/dev/custom-image.md

+
+### Final notes
+
+If we need to make changes to the operator we'll need to go through the `make


install phony only calls manifests, and skips generate. Do we need to call make generate for deep copy magic to get it into the new bundle/image?..

openshift-merge-robot · 2023-01-26T10:25:19Z

PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

openshift-ci · 2023-11-07T22:21:12Z

@Akrog: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/images	`6b414d4`	link	true	`/test images`
ci/prow/precommit-check	`6b414d4`	link	true	`/test precommit-check`
ci/prow/cinder-operator-build-deploy-kuttl	`6b414d4`	link	true	`/test cinder-operator-build-deploy-kuttl`
ci/prow/unit	`6b414d4`	link	true	`/test unit`
ci/prow/functional	`6b414d4`	link	true	`/test functional`

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

update container images to stable zed

openshift-ci bot requested review from dprince and Sandeepyadav93 November 22, 2022 13:08

Akrog force-pushed the docs branch 3 times, most recently from d3d6600 to 06a1a59 Compare November 22, 2022 15:35

cschwede self-requested a review November 22, 2022 16:16

dprince reviewed Nov 23, 2022

View reviewed changes

Akrog force-pushed the docs branch from 06a1a59 to 789cb30 Compare November 24, 2022 12:35

openshift-ci bot added the do-not-merge/hold label Nov 25, 2022

Akrog force-pushed the docs branch 2 times, most recently from 885a200 to 39cc8df Compare November 28, 2022 20:00

fmount mentioned this pull request Nov 29, 2022

Add go.work to deal with multi module dependencies #79

Merged

Akrog force-pushed the docs branch 3 times, most recently from 599afa0 to a503886 Compare December 1, 2022 15:47

openshift-ci bot added the approved label Dec 1, 2022

Akrog added 6 commits December 1, 2022 18:28

Docs: Update README.md

4dfb1e7

This patch updates the README.md file to be a bit more detailed in how we can get a working deployment with Ceph as a backend for Cinder and Glance.

Docs: Contributor guide

1d7d99f

This patch adds some documentations to help new contributors get started. It is not complete, since it doesn't explain how to work with merged and unmerged dependencies with other operators and lib-common, but it should serve as a good start.

Docs: External dependencies

78f0212

This patch introduces a couple of guides on how to do dependencies in the cinder-operator to explain simple and circular references for both running the operator locally and building the operator.

Docs: Add debug guide

cde3567

This patch introduces a simple debug guide to help new developers.

Akrog force-pushed the docs branch from a503886 to cde3567 Compare December 1, 2022 17:30

tosky reviewed Dec 6, 2022

View reviewed changes

Docs & Hack: extraVol changes

6b414d4

This patch makes changes to the getting started scripts and manifest to adapt to the new extraVol changes.

fultonj reviewed Dec 19, 2022

View reviewed changes

CONTRIBUTING.md Show resolved Hide resolved

fultonj reviewed Dec 19, 2022

View reviewed changes

bogdando reviewed Jan 12, 2023

View reviewed changes

fmount mentioned this pull request Jan 20, 2023

Remove the old Ceph section from cinder.conf #115

Merged

openshift-merge-robot added the needs-rebase label Jan 26, 2023

ASBishop pushed a commit to ASBishop/cinder-operator that referenced this pull request Mar 11, 2024

Merge pull request openstack-k8s-operators#77 from SeanMooney/zed/images

0495b5f

update container images to stable zed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs #77

Docs #77

Akrog commented Nov 22, 2022

Akrog commented Nov 22, 2022

dprince Nov 23, 2022

Akrog Nov 23, 2022

fultonj Dec 19, 2022

dprince commented Nov 23, 2022

Akrog commented Nov 23, 2022

Akrog commented Nov 25, 2022

Akrog commented Nov 25, 2022

openshift-ci bot commented Dec 1, 2022

tosky Dec 6, 2022

tosky Dec 6, 2022

tosky Dec 6, 2022

fultonj Dec 19, 2022 •

edited

Loading

fultonj Dec 19, 2022

fultonj left a comment

fultonj Dec 19, 2022

bogdando Jan 12, 2023

openshift-merge-robot commented Jan 26, 2023

openshift-ci bot commented Nov 7, 2023


		### Final notes

		If we need to make changes to the operator we'll need to go through the `make

Docs #77

Are you sure you want to change the base?

Docs #77

Conversation

Akrog commented Nov 22, 2022

Akrog commented Nov 22, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dprince commented Nov 23, 2022

Akrog commented Nov 23, 2022

Akrog commented Nov 25, 2022

Akrog commented Nov 25, 2022

openshift-ci bot commented Dec 1, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fultonj Dec 19, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fultonj left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

openshift-merge-robot commented Jan 26, 2023

openshift-ci bot commented Nov 7, 2023

fultonj Dec 19, 2022 •

edited

Loading