Bootstrap Companions in Kubernetes Environments #156
Merged
Conversation
This file contains 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
schrieveslaach
force-pushed
the
bootstrapping-k8s-companions
branch
2 times, most recently
from
9fb15a7 to
c293e03
Compare
schrieveslaach
force-pushed
the
bootstrapping-k8s-companions
branch
2 times, most recently
from
5cf9924 to
2d11894
Compare
schrieveslaach
force-pushed
the
bootstrapping-k8s-companions
branch
from
9e04a38 to
0925fc1
Compare
|
@aixigo-ohornischer, thanks for proofing this PR. |
schrieveslaach
force-pushed
the
bootstrapping-k8s-companions
branch
2 times, most recently
from
d7bdf91 to
3509e8a
Compare
This commit introduces the configuration `bootstrapping.containers` which provides a way to parse the configuration of application wide companions because the current available configuration of companions if quite limiting (Current backends, Docker and Kubernetes, offer way more options than the PREvant configuration object allows). For example, PREvant was limited to self-contained applications where each microservice only relies on interactions via network API calls (REST, database connections, messaging, etc.) With this commit PREvant is now able to deploy application companions that are more powerful than the PREvant configuration in Kubernetes backends. If `bootstrapping.containers` is defined, PREvant will start one or more containers on the infrastructure backend that are expected to generate Kubernetes manifests as output on standard out (stdout) that will be parsed by PREvant and supported are: - roles and role bindings - config maps and secrets - service accounts - persistent volume claims - services - pods, deployments, stateful sets, and jobs Then before deploying these manifests PREvant merges all objects with the objects generated from the HTTP request payload. Thus you can add or overwrite configurations. For example, you can change the image used or an environment variable. If you overwrite any configuration the companion will be turned into an instance (as PREvant did before). Ingresses won't be deployed if the bootstrap container outputs one of these. Instead they will be parsed and if they use the ingress class `nginx` they will be transformed into Traefik ingresses and middlewares so that the microservices will be available via web interface. This approach make #143 obsolete and fixes #123 and contributes to #146.
This commit ensures that there are less requests to the Kubernetes API, improving the performance. Additionally, it fixes some additional TODO comments.
schrieveslaach
force-pushed
the
bootstrapping-k8s-companions
branch
from
3509e8a to
675f26e
Compare
samuchila
suggested changes
Jan 24, 2024
schrieveslaach
force-pushed
the
bootstrapping-k8s-companions
branch
from
675f26e to
c2b240d
Compare
AnumDastgir
reviewed
Jan 25, 2024
| `registry.example.com/user/bootstrap-helm-chart:lastet` is based on a [Helm | ||
| chart][helm-chart] that generates an OpenID provider for your application with | ||
| [Keycloak][keycloak]. Additionally, it is possible to pass additional arguments | ||
| to the container than can be templated with [Handlebars][handlebars]. |
There was a problem hiding this comment.
to the container (than->that) can be templated with [Handlebars][handlebars]
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This commit introduces the configuration
bootstrapping.containerswhich provides a way to parse the configuration of application wide companions because the current available configuration of companions is quite limiting (Current backends, Docker and Kubernetes, offer way more options than the PREvant configuration object allows). For example, PREvant was limited to self-contained applications where each microservice only relies on interactions via network API calls (REST, database connections, messaging, etc.) With this commit PREvant is now able to deploy application companions that are more powerful than the PREvant configuration in Kubernetes backends.If
bootstrapping.containersis defined, PREvant will start one or more containers on the infrastructure backend that are expected to generate Kubernetes manifests as output on standard out (stdout) that will be parsed by PREvant and supported are:Then before deploying these manifests PREvant merges all objects with the objects generated from the HTTP request payload. Thus you can add or overwrite configurations. For example, you can change the image used or an environment variable. If you overwrite any configuration the companion will be turned into an instance (as PREvant did before).
Ingresses won't be deployed if the bootstrap container outputs one of these. Instead they will be parsed and if they use the ingress class
nginxthey will be transformed into Traefik ingresses and middlewares so that the microservices will be available via web interface.This approach make #143 obsolete and fixes #123 and contributes to #146.