Mappia DocsValues
Mappia is highly configurable, and you can adjust various settings to customize the deployment to your requirements. This means that you can deploy a Magento 2 application stack that meets your specific needs and optimizes performance for your specific use-case.
Parameters
Magento
| Name | Description | Value |
|---|---|---|
magento.database.persistent_connections | Turn on persistent connection to the MySQL database | 1 |
magento.backendPath | Magento admin backend path | admin |
magento.baseUrl | Magento base URL | https://www.example.com |
magento.adminUrl | Magento admin page URL | https://admin.example.com |
magento.adminFirstName | Magento admin first name | Admin |
magento.adminLastName | Magento admin last name | Admin |
magento.adminUser | Magento admin user name | admin |
magento.adminEmail | Magento admin email | admin@example.com |
magento.adminPassword | Magento admin password | mappiaAdminPassword123 |
magento.language | Magento language | en_US |
magento.minReplicas | Minimum quantity of replicas magento pods can scale to | 2 |
magento.maxReplicas | Maximum quantity of replicas magento pods can scale to | 10 |
magento.currency | Magento currency | USD |
magento.timezone | Magento timezone | America/Chicago |
magento.affinity | TODO affinity | {} |
magento.system | TODO system | {} |
magento.extraEnv | TODO extraEnv | [] |
magento.envFrom | TODO envFrom | [] |
magento.resources.requests.cpu | Magento pod inital cpu requirement | 500m |
magento.resources.requests.memory | Magento pod inital memory requirement | 800Mi |
magento.resources.limits.cpu | Magento pod cpu requirement limit | 1500m |
magento.resources.limits.memory | Magento pod memory requirement limit | 1.5Gi |
magento.cli.image | magento base image without php-fpm | mageopsrc/mirror:2.4.4-cli-alpine-v1.0.2 |
magento.cli.pullPolicy | kubernetes pull policy for cli image | IfNotPresent |
magento.fpm.image | magento base image with php-fpm | mageopsrc/mirror:2.4.4-fpm-alpine-v1.0.2 |
magento.fpm.pullPolicy | kubernetes pull policy for fpm image | IfNotPresent |
magento.containerVolumes | TODO | [] |
magento.containerVolumeMounts | TODO | [] |
upgrade | Flag to determine whether or not the upgrader pod runs. | true |
installer.enabled | Flag to enable the installer pod for configuring Magento 2 for the first time. | true |
installer.podSecurityContext | TODO | {} |
installer.ingress | configurations for installer ingress | |
installer.ingress.annotations | TODO | {} |
manager.enabled | Flag to enable the manager pod for interacting with the Magento 2 instance via CLI | true |
manager.affinity | TODO | {} |
service.type | Magento 2 Service type | ClusterIP |
service.port | Magento 2 Service port | 80 |
podSecurityContext | TODO | {} |
securityContext | TODO | {} |
Magento 2 Consumers
Magento 2 consumer settings. Controls the configuration of the consumers that process queues.
| Name | Description | Value |
|---|---|---|
consumers.affinity | Affinity for pod assignment for consumers | {} |
consumers.resources | consumer pod resources | {} |
consumers.items | List of individual consumers to run. TODO talk about existing values in the list? |
cron
Magento 2 cron settings. Controls the configuration of the background cronjob.
| Name | Description | Value |
|---|---|---|
cron.affinity | Affinity for pod assignment | {} |
cron.resources | resources for cron pod | {} |
cron.schedule | The schedule on which to run the Magento 2 Cron Job. | * * * * * |
varnish
| Name | Description | Value |
|---|---|---|
varnish | Varnish configurations. Controls versions, configurations, etc. | |
varnish.enabled | controls whether or not to enable the varnish cache. | true |
varnish.image | controls the version of varnish in use. | varnish:6.0 |
varnish.imagePullPolicy | kubernetes pull policy for varnish image. | IfNotPresent |
varnish.grace_period | Enables Varnish to keep an object in cache beyond its TTL value. | 300 |
ingress
| Name | Description | Value |
|---|---|---|
admin | ingress for the magento admin page | |
admin.ingress.enabled | enables admin ingress | true |
admin.ingress.annotations | TODO | [] |
admin.ingress.hosts | ingress hosts config | [] |
admin.ingress.tls | TODO | [] |
api | ingress configuration for magento api (REST and graphql) | |
api.ingress.enabled | enable magento api ingress | true |
api.ingress.annotations | TODO | {} |
api.ingress.hosts | ingress hosts config | [] |
api.ingress.tls | TODO | [] |
frontend | ingress configuration for magento frontend | |
frontend.ingress.enabled | enable magento frontend ingress | false |
frontend.ingress.annotations | TODO | {} |
frontend.ingress.hosts | ingress hosts config | [] |
frontend.ingress.tls | TODO | [] |
Dependencies
This section describes third party helm charts that are dependencies of this project. Please refer to each respective chart documentation page to check its specification
| Name | Description | Value |
|---|---|---|
sessioncache | bitnami/charts redis 17.8.3 https://github.com/bitnami/charts/tree/7109c7b49248c77861f29ccce2f4f8da446c2f53 | |
sharedcache | bitnami/charts redis 17.8.3 https://github.com/bitnami/charts/tree/7109c7b49248c77861f29ccce2f4f8da446c2f53 | |
rabbitmq | bitnami/charts rabbitmq 11.10.3 https://github.com/bitnami/charts/tree/bd0fbf7b4d123d1024982bc6fdbdee99ac84a8f8 | |
rabbitmq.enabled | enable rabbitmq deployment in kubernetes cluster | |
opensearch | elastic/helm-charts opensearch 1.14.0 https://github.com/opensearch-project/helm-charts/tree/1.x | |
opensearch.enabled | Enable database deployment | |
opensearch.image.tag | The OpenSearch Docker image tag | |
database | helm/charts mysql 1.6.2 https://github.com/helm/charts/tree/1a2ae3d31922592ff6e8b65660e6e49626aac54f/stable/mysql | |
database.enabled | Enable database deployment |
External Database
External Database configuration that will be imported into the env.php unless a local database is used - see database.enabled
| Name | Description | Value |
|---|---|---|
externalDatabase.host | External database host | "" |
externalDatabase.user | External database user | "" |
externalDatabase.dbname | External database name | "" |
Changelog
To 0.3
bitnami/rabbitmq (
rabbitmq) chart was updated from9.1.4to11.10.3. There was no change to the default mappia configuration. Check the bitnami/rabbitmq upgrade doc to see if any actions are necessary to your custom configuration.bitnami/redis (
sessioncacheandsharedcache) chart was updated from15.7.6to17.8.3. There was no change to the default mappia configuration. Check the bitnami/redis upgrade doc to see if any actions are necessary to your custom configuration.