-
Notifications
You must be signed in to change notification settings - Fork 302
feat: Add more information about the k8s meta package #2121
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Patrick Derks (TrayserCassa)
wants to merge
2
commits into
main
Choose a base branch
from
paas-k8s-meta
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| --- | ||
| nav: | ||
| title: K8s Meta Package | ||
| position: 90 | ||
| --- | ||
|
|
||
| # K8s Meta Package | ||
|
|
||
| The `shopware/k8s-meta` Composer package prepares your Shopware project for running on Shopware PaaS Native. It is a metapackage that installs the required dependencies and configuration files via a Symfony Flex recipe. | ||
|
|
||
| ## Version compatibility | ||
|
|
||
| Use the version that matches your Shopware installation: | ||
|
|
||
| | Shopware version | k8s-meta version | | ||
| |------------------|------------------| | ||
| | 6.6 | `^1.0` | | ||
| | 6.7 | `^2.0` | | ||
|
|
||
| Install it with: | ||
|
|
||
| ```sh | ||
| composer require shopware/k8s-meta:^2.0 --ignore-platform-reqs | ||
| ``` | ||
|
|
||
| :::info | ||
| The `--ignore-platform-reqs` flag ensures that all necessary recipes are installed, even if your local PHP version differs from the required platform version. | ||
| ::: | ||
|
|
||
| ## What it installs | ||
|
|
||
| ### Dependencies | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we want to have the exhaustive list of dependencies? Because then we would need to update this page. |
||
|
|
||
| The metapackage pulls in the following dependencies: | ||
|
|
||
| | Package | Purpose | | ||
| |--------------------------------------|----------------------------------------------------| | ||
| | `league/flysystem-async-aws-s3` | S3-compatible filesystem for media and assets | | ||
| | `open-telemetry/exporter-otlp` | OpenTelemetry tracing export | | ||
| | `open-telemetry/transport-grpc` | gRPC transport for OpenTelemetry | | ||
| | `shopware/opentelemetry` | Shopware OpenTelemetry integration | | ||
| | `shopware/docker` | Docker and deployment helper tooling | | ||
| | `symfony/redis-messenger` | Redis-based message queue transport | | ||
|
|
||
| ### Configuration files | ||
|
|
||
| The Symfony Flex recipe creates the file `config/packages/operator.yaml`. After installation, verify that this file exists in your project. | ||
|
|
||
| This file configures Shopware for the PaaS Native infrastructure: | ||
|
|
||
| - **S3 object storage** for public, private, theme, and sitemap filesystems | ||
| - **Redis** for application cache and session storage | ||
| - **Cluster mode** settings (`cluster_setup: true`, `runtime_extension_management: false`) | ||
| - **Admin worker** disabled (queues are processed externally) | ||
| - **Elasticsearch/OpenSearch** replica and shard settings | ||
| - **Monolog** logging to stderr in JSON format | ||
|
|
||
| Additionally, files in `config/packages/prod/` configure production-specific behavior: | ||
|
|
||
| | File | Purpose | | ||
| |-----------------------|--------------------------------------------------| | ||
| | `fastly.yaml` | Fastly CDN reverse proxy and cache purging | | ||
| | `monolog.yaml` | Error-level logging to stderr in JSON format | | ||
| | `opentelemetry.yaml` | OpenTelemetry profiler integration | | ||
|
|
||
| ## Overriding configuration | ||
|
|
||
| :::warning | ||
| The default configuration is tuned for the PaaS Native infrastructure. Changing values can break your application if you are not familiar with the underlying services. Only override settings when you have a clear reason to do so. | ||
| ::: | ||
|
|
||
| You can override any value from `operator.yaml` using the standard Symfony configuration override mechanism. Place a YAML file in `config/packages/prod/` with the same configuration keys, and its values will take precedence. | ||
|
|
||
| For example, to enable soft purge with stale cache serving, create or edit a file in `config/packages/prod/`: | ||
|
|
||
| ```yaml | ||
| # config/packages/prod/shopware.yaml | ||
| shopware: | ||
| http_cache: | ||
| stale_while_revalidate: 300 | ||
| stale_if_error: 3600 | ||
| ``` | ||
|
|
||
| For more details on how Symfony merges configuration files, refer to the [Symfony configuration documentation](https://symfony.com/doc/current/configuration.html#configuration-environments). | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the dependencies mechanism should chose which version.