ENDOC-525 Create new ent CLI Services page #541
Conversation
| - The username and password are derived from the bundle name, e.g. YOUR-BUNDLE has the username YOUR-BUNDLE-USER and the password YOUR-BUNDLE-PASSWORD | ||
| - A database is automatically created and given the bundle name, e.g. YOUR-BUNDLE | ||
|
|
||
| - `keycloak` contains the Entando-related configuration |
There was a problem hiding this comment.
this phrase is left hanging? Colon?
Entando-related configuration >> Entando configuration
There was a problem hiding this comment.
i didn't use colons because the first keycloak bullet provides general info but the indents provide unrelated, additional details. a colon fits for mysql/postgresql (indents expand upon first bullet) but i wanted to be consistent.
this one bothered me. both seem wrong for different reasons. @nshaw does the revision work?
There was a problem hiding this comment.
Formatting looks okay when I view the full file
|
|
||
| ## Commands | ||
|
|
||
| Use `ent bundle svc` to enable, disable, start, stop, restart, print the logs of, or list services. Services must be formatted as Docker Compose YAML files in the 'svc' bundle folder. |
There was a problem hiding this comment.
this seems unnecessary as it is listed all below
There was a problem hiding this comment.
doesn't do any harm and introduces the ent bundle svc command
|
|
||
| **Command details:** | ||
|
|
||
| - `svc enable`: Adds the service(s) to the 'svc' attribute of the bundle descriptor |
There was a problem hiding this comment.
i think this description belongs in the table above and no additional details are necessary. This one is more clear what it does.
Same for disable. The aux services is not clear> they have to go looking for what is aux services
There was a problem hiding this comment.
?? we're talking about aux services. these are all aux services, but only if they're added to the attribute and follow the required file format / dir placement. otherwise they may be services but they're not an aux service of the bundle. did the reverse because the intro paragraph calls out the svc attribute
There was a problem hiding this comment.
was just pointing out that you end up having to read the table and the details below. I think the details section would be unnecessary if those descriptions were put in the table.
Maybe I'm confused, but are there other services besides aux services
There was a problem hiding this comment.
? i already edited this
services is a very broad term, so absolutely
|
|
||
| - `svc disable`: Removes the service(s) from the 'svc' attribute of the bundle descriptor | ||
|
|
||
| - `svc logs`: The log of a running service will continue to update until exited via `Ctrl+C` |
There was a problem hiding this comment.
until exited via Ctrl+C>> sounds awkward and don't think we need to back tick Ctrl-C
There was a problem hiding this comment.
disagree
we decided to backtick Ctrl+C a few months ago, and to use + instead of -
There was a problem hiding this comment.
got the sign wrong, meant to do + . Pretty sure we just decided on Ctrl+C but the backtick is not a big deal. (4-5-22)
There was a problem hiding this comment.
that decision doesn't make any mention of backticking, so i'm going off of how ctrl+c is usually formatted on the developer site. i have no strong feelings about this. just aiming for consistency.
| - All roles and permissions are preset, based on the Keycloak realm-config file | ||
| - The `keycloak.yaml`, realm-config and user config files are located in the 'keycloak' folder inside 'svc' | ||
|
|
||
| A custom service can be added to a bundle's 'svc' folder as a Docker Compose YAML file. The file and service must have the same name, e.g. if the service filename is `mysql.yml`, then the service name must be `mysql`: |
There was a problem hiding this comment.
a custom service can be added 'as' a Docker Compose... >> as sounds odd, maybe with?
There was a problem hiding this comment.
the service is the file
There was a problem hiding this comment.
A Docker Compose file can contain multiple things. In this case it looks like Eng has a convention of 1 Docker Compose YAML File defining a single named service. So 'as' works for me.
|
|
||
| Use `ent bundle svc` to enable, disable, start, stop, restart, print the logs of, or list services. Services must be formatted as Docker Compose YAML files in the 'svc' bundle folder. | ||
|
|
||
| To run auxiliary operations, a service must be enabled. Enabled services are listed under the 'svc' attribute of the bundle descriptor, `entando.json`. Common auxiliary service commands are detailed below. |
There was a problem hiding this comment.
not sure about 'auxiliary operations' here >> simplify >> a service must be enabled before it can be used
There was a problem hiding this comment.
the service performs auxiliary operations. the current wording is precise and connects the dots.
There was a problem hiding this comment.
This explanation does help me connect it all.
| - All roles and permissions are preset, based on the Keycloak realm-config file | ||
| - The `keycloak.yaml`, realm-config and user config files are located in the 'keycloak' folder inside 'svc' | ||
|
|
||
| A custom service can be added to a bundle's 'svc' folder as a Docker Compose YAML file. The file and service must have the same name, e.g. if the service filename is `mysql.yml`, then the service name must be `mysql`: |
There was a problem hiding this comment.
A Docker Compose file can contain multiple things. In this case it looks like Eng has a convention of 1 Docker Compose YAML File defining a single named service. So 'as' works for me.
|
|
||
| Use `ent bundle svc` to enable, disable, start, stop, restart, print the logs of, or list services. Services must be formatted as Docker Compose YAML files in the 'svc' bundle folder. | ||
|
|
||
| To run auxiliary operations, a service must be enabled. Enabled services are listed under the 'svc' attribute of the bundle descriptor, `entando.json`. Common auxiliary service commands are detailed below. |
There was a problem hiding this comment.
This explanation does help me connect it all.
| - The username and password are derived from the bundle name, e.g. YOUR-BUNDLE has the username YOUR-BUNDLE-USER and the password YOUR-BUNDLE-PASSWORD | ||
| - A database is automatically created and given the bundle name, e.g. YOUR-BUNDLE | ||
|
|
||
| - `keycloak` contains the Entando-related configuration |
There was a problem hiding this comment.
Formatting looks okay when I view the full file
|
|
||
| # Auxiliary Services | ||
|
|
||
| The following sections discuss auxiliary services and commands. |
There was a problem hiding this comment.
Maybe it was listed elsewhere but I think we need to call out that these "auxiliary" services are purely for a local development environment. In Kubernetes these services are provided by the platform (e.g. keycloak or RedHat SSO) or configuration settings can be enabled to point to externally managed services (like mysql or postgresql). It took me a minute to sort that out.
There was a problem hiding this comment.
i really don't remember reading that anywhere and it gives some missing context/explanation
| @@ -4,7 +4,9 @@ sidebarDepth: 1 | |||
|
|
|||
| # Auxiliary Services | |||
|
|
|||
| The following sections discuss auxiliary services and commands. | |||
| Auxiliary services extend the capabilities of a local development environment. Kubernetes can be configured to point to externally managed services, such as MySQL or PostgreSQL, or services are provided by the platform (e.g. Keycloak or RedHat SSO). | |||
There was a problem hiding this comment.
Getting closer. Maybe this is even clearer "Auxiliary services add capabilities to a local environment to help accelerate application development. In a full Kubernetes setting, by comparison, the equivalent services are either provisioned by the Entando platform or the application can be configured to point to externally managed services."
No description provided.