artemiscloud / activemq-artemis-operator

Apache License 2.0
69 stars 63 forks source link

documentation: update operator documentation #870

Closed Msarawan closed 7 months ago

Msarawan commented 7 months ago

Updated operator documentation.

brusdev commented 7 months ago

After taking a deeper look to the current bundle.md, I think it require a deeper refactoring:

  1. The steps to build the bundle image should be removed because now the CI workflow push the official bundle images to quay.io/artemiscloud/activemq-artemis-operator-bundle
  2. The v prefix should be removed from the tag versions
  3. The private repo quay.io/hgao should be removed by the public doc
  4. The catalog image tag should not match the operator version because a catalog image usually hosts multiple operators
gaohoward commented 7 months ago

After taking a deeper look to the current bundle.md, I think it require a deeper refactoring:

1. The steps to [build the bundle image](https://github.com/artemiscloud/activemq-artemis-operator/blob/1.2.0/docs/help/bundle.md#building-the-bundle-image) should be removed because now the CI workflow push the official bundle images to quay.io/artemiscloud/activemq-artemis-operator-bundle

2. The `v` prefix should be removed from the tag versions

3. The private repo `quay.io/hgao` should be removed by the public doc

4. The catalog image tag should not match the operator version because a catalog image usually hosts multiple operators
  1. we can reference the bundle repository here, users who follow the doc don't need build themselves. and adjust the Building the catalog image accordingly.

Also the Installing olm , the command operator-sdk olm install no longer works, we can replace it by using the olm installation doc or use our script hack/install_olm.sh

brusdev commented 7 months ago

@Msarawan I think it still requires a deeper refactoring. I created a draft with the minimum steps required to clarify what I mean https://github.com/brusdev/activemq-artemis-tutorials/tree/main/activemq-artemis-bundle

That draft works with the v prefix removed from the tag versions:

diff Makefile
-BUNDLE_IMG ?= $(IMAGE_TAG_BASE)-bundle:v$(VERSION)
+BUNDLE_IMG ?= $(IMAGE_TAG_BASE)-bundle:$(VERSION)

-CATALOG_IMG ?= $(IMAGE_TAG_BASE)-catalog:v$(VERSION)
+CATALOG_IMG ?= $(IMAGE_TAG_BASE)-catalog:$(VERSION)
Msarawan commented 7 months ago

@Msarawan I think it still requires a deeper refactoring. I created a draft with the minimum steps required to clarify what I mean https://github.com/brusdev/activemq-artemis-tutorials/tree/main/activemq-artemis-bundle

That draft works with the v prefix removed from the tag versions:

diff Makefile
-BUNDLE_IMG ?= $(IMAGE_TAG_BASE)-bundle:v$(VERSION)
+BUNDLE_IMG ?= $(IMAGE_TAG_BASE)-bundle:$(VERSION)

-CATALOG_IMG ?= $(IMAGE_TAG_BASE)-catalog:v$(VERSION)
+CATALOG_IMG ?= $(IMAGE_TAG_BASE)-catalog:$(VERSION)

Thanks for the clarification, @brusdev . It makes sense to me. I'll update the document by referring to the draft Readme file.

brusdev commented 7 months ago

@Msarawan can you squash your commits?

Msarawan commented 7 months ago

@Msarawan can you squash your commits?

Sure, i will do.

gaohoward commented 7 months ago

@Msarawan @brusdev I run this command and still got the error (I think it's pulling v1.2.1 rather then 1.2.1 bundle), I think we should change Makefile here to remote the 'v' from the version tag.

make CATALOG_IMG=quay.io/my-org/activemq-artemis-operator-index:latest catalog-build

./bin/opm index add --container-tool docker --mode semver --tag quay.io/my-org/activemq-artemis-operator-index:latest --bundles quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1 
WARN[0000] DEPRECATION NOTICE:
Sqlite-based catalogs and their related subcommands are deprecated. Support for
them will be removed in a future release. Please migrate your catalog workflows
to the new file-based catalog format. 
INFO[0000] building the index                            bundles="[quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1]"
INFO[0000] running /usr/bin/docker pull quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1  bundles="[quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1]"
ERRO[0006] Error response from daemon: manifest for quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1 not found: manifest unknown: manifest unknown  bundles="[quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1]"
INFO[0006] running docker create                         bundles="[quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1]"
ERRO[0012] permissive mode disabled                      bundles="[quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1]" error="[error pulling image: Error response from daemon: manifest for quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1 not found: manifest unknown: manifest unknown\n. exit status 1, error creating container : exit status 1: Unable to find image 'quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1' locally\nError response from daemon: manifest for quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1 not found: manifest unknown: manifest unknown\n]"
Error: [error pulling image: Error response from daemon: manifest for quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1 not found: manifest unknown: manifest unknown
. exit status 1, error creating container : exit status 1: Unable to find image 'quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1' locally
Error response from daemon: manifest for quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1 not found: manifest unknown: manifest unknown
Msarawan commented 7 months ago

@Msarawan @brusdev I run this command and still got the error (I think it's pulling v1.2.1 rather then 1.2.1 bundle), I think we should change Makefile here to remote the 'v' from the version tag.

make CATALOG_IMG=quay.io/my-org/activemq-artemis-operator-index:latest catalog-build

./bin/opm index add --container-tool docker --mode semver --tag quay.io/my-org/activemq-artemis-operator-index:latest --bundles quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1 
WARN[0000] DEPRECATION NOTICE:
Sqlite-based catalogs and their related subcommands are deprecated. Support for
them will be removed in a future release. Please migrate your catalog workflows
to the new file-based catalog format. 
INFO[0000] building the index                            bundles="[quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1]"
INFO[0000] running /usr/bin/docker pull quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1  bundles="[quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1]"
ERRO[0006] Error response from daemon: manifest for quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1 not found: manifest unknown: manifest unknown  bundles="[quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1]"
INFO[0006] running docker create                         bundles="[quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1]"
ERRO[0012] permissive mode disabled                      bundles="[quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1]" error="[error pulling image: Error response from daemon: manifest for quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1 not found: manifest unknown: manifest unknown\n. exit status 1, error creating container : exit status 1: Unable to find image 'quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1' locally\nError response from daemon: manifest for quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1 not found: manifest unknown: manifest unknown\n]"
Error: [error pulling image: Error response from daemon: manifest for quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1 not found: manifest unknown: manifest unknown
. exit status 1, error creating container : exit status 1: Unable to find image 'quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1' locally
Error response from daemon: manifest for quay.io/artemiscloud/activemq-artemis-operator-bundle:v1.2.1 not found: manifest unknown: manifest unknown

Hey @gaohoward, I encountered the same error you mentioned. I couldn't check it yesterday due to getting some issues while installing olm in my local machine, but I ran the command today and got the same error. I tried removing the v from the makefile, and it worked.