Uploaded image for project: 'AMQ Broker'
  1. AMQ Broker
  2. ENTMQBR-7380

OCP Change structure of provided install & example files

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Unresolved
    • Icon: Major Major
    • None
    • None
    • operator

      Current structure of installation is very basic and not very user friendly.

      Make structure nicer, easier to use and plausible to end-user.

      Don't scare new users by showing all files at ocp-install-examples.zip file.

       

      initial PR https://github.com/artemiscloud/activemq-artemis-operator/pull/360/

      Suggested conventions to use from now on (on all provided examples and install files):

      • use only underscores in files (don't mix dashes/minuses and underscores)
      • Update README.md with more suitable wording
        • backreference upstream project or get rid of completely make generate-deploy goal
      • Unify CR/CRD naming structure
      • Simplify installation and instructions (ideally just change namespace and decide on namespace/cluster-wide operator deployment)

       

      Update: OCP installexample zip file folder itself has parent folder `deploy` which is somehow not needed. Can we get rid of it as well?

      ❯ pwd
      /home/mtoth/work/broker-ocp/amq-broker-operator-7.10.1-ocp-install-examples
      ❯ ls
      deploy
      ❯ ls deploy
      cluster_role_binding.yaml    crs                         install_opr.sh        README.md             undeploy_all.sh
      cluster_role.yaml            election_role_binding.yaml  olm-catalog           role_binding.yaml
      cluster_wide_install_opr.sh  election_role.yaml          operator_config.yaml  role.yaml
      crds                         examples                    operator.yaml         service_account.ya 

      So we would end up with something like this:

      ❯ pwd
      /home/mtoth/work/broker-ocp/amq-broker-operator-7.10.0-ocp-install-examples 
      ❯ ls --group-directories-first
      examples  olm-catalog                  deployment.yaml  pull_secret.json  undeploy_all.sh
      install   cluster_wide_install_opr.sh  install_opr.sh   README.md 

      ===
      UPD: I have opened a PR to simplify examples as well https://github.com/artemiscloud/activemq-artemis-operator/pull/372

      I believe we should merge this PR as is (unless some work is needed) - for 7.11.0.
      And in next PRs (post 7.11.0 release), we could slowly introduce new "production-like" examples, which would be tested.

            Unassigned Unassigned
            mtoth@redhat.com Michal Toth
            Domenico Francesco Bruscino, Dominik Lenosi, Gary Tully, Howard Gao, John Clifford, Michal Toth, Paul Wright, Roderick Kieley
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated: