Add Flow CR documentation #252
Conversation
✅ Deploy Preview for pedantic-goldberg-f76ec1 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
hasancelik
requested review from
amandalindsay and
atilsensalduz
and removed request for
oliverhowell
| == Prerequisites | ||
|
|
||
| - Flow requires the Management Center application to run and be configured properly. The Management Center application should be configured to use FLow. | ||
|
|
There was a problem hiding this comment.
Please mention FLOW MC image should be used here --> docker.io/hazelcast/management-center-flow
There was a problem hiding this comment.
I have added it to the example config with the following description
Co-authored-by: Amanda Lindsay <[email protected]>
| name: flow <3> | ||
| jvm: | ||
| args: | ||
| - "-Dhazelcast.mc.flow.addresses=http://233.252.0.158/" <4> |
There was a problem hiding this comment.
Not sure if you commonly use this elsewhere, but this ip in the examples looks slightly strange to me, it being ASM reserved makes it look super specific, but I presume it's just a placeholder, could perhaps replace with a placeholder FQDN instead?
There was a problem hiding this comment.
Well, I specifically used the IP range reserved for documentation purposes as a placeholder. In the description, I have explained that it should be publicly available one 😄
docs/modules/ROOT/pages/flow.adoc
Outdated
| <4> Flow Ingress public address. | ||
| <5> The internal address of Flow in the format of `http://<service-name>:9021`. The service name is the same as the Flow CR name. | ||
|
|
||
| - To connect to the database you need create a `Secret` with the DB credentials: |
There was a problem hiding this comment.
The DB have to be Postgre so we should mention in here or at the beginning of the section. WDYT?
There was a problem hiding this comment.
I thought we didn't mention it on purpose, don't we?
There was a problem hiding this comment.
Why?
If flow mentioned about it we can give reference to it also
|
I think we should also mention about license usage also. Users can not use their regular license key but they can use their flow specific license key for the flow, and MC flow via creation one k8s secret. WDYT? |
@hasancelik but is it an Operator specific thing? In my understanding, that should be in the Flow documentation. Operator only configure the Flow with the given licence, but we don't validate |
No description provided.