Uploaded image for project: 'Red Hat Fuse'
  1. Red Hat Fuse
  2. ENTESB-13408 Cleanup installation and usage instructions
  3. ENTESB-13256

Common format and improvements of quickstart's README.didact.md

    XMLWordPrintable

Details

    • Sub-task
    • Resolution: Done
    • Critical
    • None
    • fuse-next-TP1-GA
    • Camel-K
    • None

    Description

      We should establish a common format for all quickstarts README.didact.md

      OperatorHub installation

      Unify OperatorHub installation steps. We introduced two different approaches to our quickstarts.

      #1 Manually - camel-k-example-vdb
      Now, go to your OpenShift 4.x WebConsole page, and find the OperatorHub menu item on left hand side menu and find and install "Data Virtualization Operator". This may take couple minutes to install.
      
      #2 Didact steps - camel-k-example-event-streaming
      That creates a secluded space where AMQ Streams can run. To deploy it, we subscribe to the AMQ Streams channel by using the following command:
      
      oc apply -f infra/kafka/amq-streams-subscription.yaml
      

      https://github.com/openshift-integration/camel-k-example-event-streaming/blob/master/infra/kafka/amq-streams-subscription.yaml#L19
      https://github.com/openshift-integration/camel-k-example-event-streaming/blob/master/infra/messaging/broker/amq-broker-subscription.yaml#L19

      Personally I would prefer #2 - we can easily specify dependency version (see ENTESB-13255)

      redhat.io secret

      We need a secret in order to download images from redhat.io. We should add a check for the secret to the #Requirements section and provide steps to install it to the cluster.

      kamel install needs cluster-admin role

      Add check to #Requirements section for cluster-admin privileges

      uninstalling steps

      Quickstarts are missing uninstalling steps.

      Attachments

        Issue Links

          Activity

            People

              nicolaferraro Nicola Ferraro (Inactive)
              jbouska@redhat.com Jan Bouska
              Lukas Lowinger Lukas Lowinger
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: