ENDOC-546 build and publish a v5 bundle project #566
Conversation
vuepress/docs/next/tutorials/create/pb/publish-project-bundle.md
Outdated
Show resolved
Hide resolved
vuepress/docs/next/tutorials/create/pb/publish-project-bundle.md
Outdated
Show resolved
Hide resolved
vuepress/docs/next/tutorials/create/pb/publish-project-bundle.md
Outdated
Show resolved
Hide resolved
| ## Overview | ||
| This tutorial demonstrates how to deploy an existing Entando project directory into the [Local Hub](../../../docs/getting-started/concepts-overview.md#local-hub). This involves building a Docker image from your microservice, creating an Entando Bundle, checking your Bundle artifacts into Git, and deploying the Bundle into Kubernetes. | ||
| This tutorial demonstrates how to deploy an existing Entando project directory into the [Local Hub](../../../docs/getting-started/concepts-overview.md#local-hub). The process involves: |
There was a problem hiding this comment.
"includes" is not exhaustive, whereas "involves" seems more representative of everything; i.e. "includes" is "some but not limited to" while "involves" approaches all-encompassing. regardless, i was not happy with the word choice
|
|
||
| The Entando CLI (ent) automates many of the tasks involved in deploying an Entando Bundle, but you can also choose to perform these tasks manually. | ||
| 1. Building a Docker image from a microservice |
There was a problem hiding this comment.
The continuous present tense seems strange, like it's continuously happening. maybe change to simple present like build, define, push...
There was a problem hiding this comment.
agree. i changed to continuous because i was struggling to find a lead up i was happy with (don't start two sentences in a row with "this," don't add unnecessary or redundant verbiage, etc.)
| > **Note** | ||
| > | ||
| > The output image name is generated using the organization value defined during project initialization. You can override the provided values by altering the `pom.xml` file or by customizing the `-Djib.to.image` parameter used by the `./mvnw` command. | ||
| The Entando Bundle CLI tool (**ent bundle**) automates many of the tasks involved in deploying an Entando project bundle. |
There was a problem hiding this comment.
@nshaw, should there be a mention and link to how to do this for V1 bundles?
There was a problem hiding this comment.
Just to document, we discussed on the call and decided it's not needed here.
|
|
||
| 7. Generate a custom resource for your bundle. Update the following command with your bundle name, namespace and repository URL. | ||
| 1. Create an Entando project directory, either [from scratch](./publish-simple-bundle.md) or [using the Entando Component Generator](../ms/generate-microservices-and-micro-frontends.md) |
There was a problem hiding this comment.
[using the Entando >> use the Entando or by using
| ``` sh | ||
| ent bundle pack | ||
| ``` | ||
| This builds the bundle components and constructs the Docker images. |
There was a problem hiding this comment.
not really needed since it's mentioned above. Add the bit about components to that part too
There was a problem hiding this comment.
it's worth mentioning that the pack command also performs the build
| > **Note** | ||
| > | ||
| > In the event of a timeout or pod failure, refer to the errors captured by the quickstart-cm-deployment and plugin deployer logs. | ||
| 5. Install the bundle in your Entando Application from `App Builder` → `Hub` or with the following command: |
There was a problem hiding this comment.
This is a bit confusing, because they'd already be in the Hub with step 4
There was a problem hiding this comment.
there is a difference between deploy and install
| 2. Push the bundle artifact to a Docker registry | ||
| 3. Apply the bundle custom resource to Kubernetes | ||
| 4. Install the bundle into an Entando Application | ||
| 1. Defining the bundle component |
There was a problem hiding this comment.
again, prefer simple tense for the list. The continuous tense seems strange, like it just keeps happening
There was a problem hiding this comment.
maybe i don't want to feel alone in doing these steps over and over :P
| > **Note** | ||
| > | ||
| > The output image name is generated using the organization value defined during project initialization. You can override the provided values by altering the `pom.xml` file or by customizing the `-Djib.to.image` parameter used by the `./mvnw` command. | ||
| The Entando Bundle CLI tool (**ent bundle**) automates many of the tasks involved in deploying an Entando project bundle. |
There was a problem hiding this comment.
Just to document, we discussed on the call and decided it's not needed here.
|
|
||
| ## Create and Deploy a Bundle Project | ||
|
|
||
| The following steps leverage the Entando `ent bundle` command and its convenience methods. | ||
|
|
||
| 1. Create an Entando project directory, either [from scratch](./publish-simple-bundle.md) or [using the Entando Component Generator](../ms/generate-microservices-and-micro-frontends.md) | ||
| 1. Create |
There was a problem hiding this comment.
not sure if I'm supposed to review this but this step seems missing something
No description provided.