docker login repository.broadleafcommerce.com:5001
- v1.0.0-latest-prod
Now that you have your own container images built and deployed to your own registry, you can now utilize our example Helm charts as a starter to deploy your various Broadleaf Flex Package compositions to an existing Kubernetes cluster. See the Deployment Flexibility article for more details if you’re not familiar with Broadleaf’s Flex Package technology.
The following section is only applicable to Initializr-based projects
With an initializr-based project, we’ve made it easy to generate the necessary helm charts that represent the Flex Component Compositions represented in your manifest.yml .
helm:generate Maven PluginIn your manifest directory, execute the following command ./mvnw helm:generate which when invoked, will produce the appropriate helm charts in a helm directory located at the same directory alongside the rest of the generated project artifacts.
This helm directory also contains several install scripts that make it easy for you to install your Broadleaf ecosystem into a Kubernetes cluster. Please follow the Deploy to Kubernetes tutorial for details on use.
The following section is only applicable to legacy MicroservicesDemo-based projects only
|
Note
|
Please see the README on the "Helm Charts Starter" project that is included with the MicroserviceDemo Project Starters. This project provides a base starting point that you can use as a reference for your specific deployment as well as provides a sample install.sh script to deploy all the resources requirerd in a full Broadleaf installation containing all the demo starter images
|
|
Important
|
All references to a "Starter Project" or "Demo Images" assumes you have obtained credentials outlined in the guide: Getting Started Locally and you have the ability to authenticate with Broadleaf’s docker registry and maven nexus. e.g. |
The following tables describe the various demo images that are available and used across the different Microservice Starter Projects. This serves as a general reference to their relative location within the base Helm charts or starter umbrella charts. The expectation being that clients replace these demo images with their own in a real implementation.
|
Note
|
typically the image tag versions defined in the starter project’s charts represent the latest stable releases of the current demo |
| Resource | Primary Container Demo Image | Base Chart | Umbrella Chart |
|---|---|---|---|
Backoffice Admin Gateway |
|
|
|
Backoffice Admin |
|
|
|
Customer Facing Storefront Gateway |
|
|
|
Customer Facing Storefront |
|
|
|
Kafka |
|
|
|
Open API UI |
|
|
|
Solr |
|
|
|
Zookeeper |
|
|
|
ZK UpConfig Job - a Kubernetes Job that "upconfigs" Broadleaf SOLR schema configuration to Zookeeper. Assumes zookeeper is up and running. |
|
|
|
Data Job - [Initializr-based] a Kubernetes Job that initializes Broadleaf Liquibase Schema changes - NOTE: this only applies to initializr based projects. |
|
|
|
| Name | Typical Helm Installation | Notes |
|---|---|---|
Kube Prometheus Stack |
|
Typical Broadleaf overrides and settings can be found in: |
Elastic Stack |
|
Sample APM Server and Filebeat config are located in |
The following sections represent the different images used depending on which example flex package composition you choose to deploy for your core commerce backend services.
| Resource | Primary Container Demo Image | Base Chart | Umbrella Chart |
|---|---|---|---|
Auth Service |
|
|
|
| Resource | Primary Container Demo Image | Base Chart | Umbrella Chart |
|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
n/a |
|
|
|
n/a |
|
|
|
|
|
|
|
Note
|
(*) The Processing Flex Package has some unique properties wherein some services are only included with input listeners for import and sandboxing transitions ONLY (and will be exempt from servicing typical request traffic). i.e. heavy back office functions can be scaled independently while not impacting customer facing browse flows or vice versa. |
The following represents all the services deployed individually.
| Resource/Image | Base Helm Chart | Umbrella Chart |
|---|---|---|
|
|
|
|
|
|
|
|
|
[DEPRECATED] |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[DEPRECATED] |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Granular Common ENV Config Map |
|
|
Granular Routes ENV Config Map |
|
|
SOLR Create Collection JOB - |
|
|