Include building and custom deployment instructions in README

[abramche]

Currently the documentation does not include information how to build Operator, publish the custom builds and make use of them in own environment (well, the latter is implicitly included).

Since it all is entirely possible for everybody, it would be a nice idea to include it all in our documentation.

[mflendrich]

Currently the documentation does not include information how to build Operator

scylla-operator/CONTRIBUTING.md

Line 13 in 6b07cf1

* `make build` - build project binaries

publish the custom builds and make use of them in own environment

scylla-operator/CONTRIBUTING.md

Line 55 in 6b07cf1

A ScyllaDB Operator image based on the local code will be built and loaded into the Kind cluster automatically.

@abramche What use case are you missing?

[abramche]

@abramche What use case are you missing?

Perhaps I chose bad wording indeed. I meant, from an outside perspective, suppose there is someone who wants to make a change, build an image, publish it and use in own k8s cluster (not kind-local).

We do provide some hints on building the binary and hack-deploying into kind, but we do not cover the other user journey (idk if it is a likely one...)

[czeslavo]

I think that we could document a "Build your own Operator and deploy it" from the developer perspective, but we should be strict about not communicating it as a recommended way for production use, for sure (at least if a user expects support from our side).

If you don't mind, I suggest that we make this issue a bag for your operator learning journey's findings regarding poor dev experience documentation so that we can fix them all at once, ideally with your contribution :)

[scylla-operator-bot]

The Scylla Operator project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 30d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle stale
• Close this issue with /close
• Offer to help out

/lifecycle stale

[scylla-operator-bot]

The Scylla Operator project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 30d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle rotten
• Close this issue with /close
• Offer to help out

/lifecycle rotten

[abramche]

After the docs rewrite, the custom build deployment instructions are improved but involve make targets build-image, push-image and deploy which are absent from the Makefile?

/remove-lifecycle rotten

[scylla-operator-bot]

The Scylla Operator project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 30d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle stale
• Close this issue with /close
• Offer to help out

/lifecycle stale