Review eventing doc and added automated installation script #498
Conversation
gabriel-farache
force-pushed
the
feat/automate_eventing
branch
from
c740147 to
9070efa
Compare
| ## Automated installation steps | ||
| Usage: | ||
| ``` | ||
| Usage: ORCHESTRATOR_NAME=ORCHESTRATOR_NAME BROKER_NAME=BROKER_NAME BROKER_NAMESPACE=BROKER_NAMESPACE [KAFKA_REPLICATION_FACTOR=KAFKA_REPLICATION_FACTOR] [ORCHESTRATOR_NAMESPACE=openshift-operators] [BROKER_TYPE=kafka] [INSTALL_KAFKA_CLUSTER=true] ./eventing-automate-install.sh |
There was a problem hiding this comment.
can you breakdown this line into multiple lines? it is rendered as a very long line.
In addition, the copy button will copy everything.
There was a problem hiding this comment.
it's the usage text, it does not aim to be copy/paste, instead the commands below should be used
| ORCHESTRATOR_NAMESPACE Optional, namespace in which the orchestrator operator is depoyed. Default is openshift-operators | ||
| BROKER_NAME Name of the broker to install | ||
| BROKER_NAMESPACE Namespace in which the broker must be installed | ||
| BROKER_TYPE Optional , type of the broker. Either 'kafka' or 'in-memory'. Default is: 'kafka' |
There was a problem hiding this comment.
Can the broker type be other than in-memory or kafka?
Perhaps this can be named IN_MEMORY_BROKER with a boolean value, with false as a default?
Being explicit is also fine.
There was a problem hiding this comment.
Can the broker type be other than in-memory or kafka
Yes https://knative.dev/docs/eventing/brokers/broker-types/
But I think we do not want to support it
I like being explicit so if we have to support a new type of broker it will be easier and limit the amount of env var to set
gabriel-farache
force-pushed
the
feat/automate_eventing
branch
from
3231651 to
18c6bdd
Compare
gabriel-farache
force-pushed
the
feat/automate_eventing
branch
from
18c6bdd to
025114e
Compare
gabriel-farache
force-pushed
the
feat/automate_eventing
branch
from
025114e to
a3d5b84
Compare
Signed-off-by: gabriel-farache <gfarache@redhat.com>
gabriel-farache
force-pushed
the
feat/automate_eventing
branch
from
a3d5b84 to
89fcdc7
Compare
Review eventing doc and added automated installation script