docs: Added better instructions for deploying helm charts#15056
Merged
mpfirrmann merged 5 commits intomagma:masterfrom Mar 6, 2023
Merged
docs: Added better instructions for deploying helm charts#15056mpfirrmann merged 5 commits intomagma:masterfrom
mpfirrmann merged 5 commits intomagma:masterfrom
Conversation
Contributor
|
Thanks for opening a PR! 💯
Howto
More infoPlease take a moment to read through the Magma project's
If this is your first Magma PR, also consider reading
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
Contributor
|
Oops! Looks like you failed the Howto
♻️ Updated: ✅ The check is passing the Docs Lint & Check Generated Files In Sync after the last commit. |
MoritzThomasHuebner
force-pushed
the
helm_docs_update
branch
from
9508fe6 to
c3d17de
Compare
Added missing environment variable and pointed to example values files. Signed-off-by: Moritz Huebner <[email protected]>
Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]>
Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]>
Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]>
MoritzThomasHuebner
force-pushed
the
helm_docs_update
branch
from
c5bdd84 to
3d18bc1
Compare
pull-request-size
bot
added
size/M
MoritzThomasHuebner
force-pushed
the
helm_docs_update
branch
from
3d18bc1 to
a06df5d
Compare
| --set-file 'secret.certs.files.fluentd\.key'=${CERTS_DIR}/fluentd.key \ | ||
| --set=docker.registry=${IMAGE_REGISTRY_URL} \ | ||
| --set=docker.username=${IMAGE_REGISTRY_USERNAME} \ | ||
| --set=docker.password=${IMAGE_REGISTRY_PASSWORD} | |
Contributor
Author
There was a problem hiding this comment.
All secrets need to be applied together. Otherwise pods fail because they cannot find relevant certs.
Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]>
MoritzThomasHuebner
force-pushed
the
helm_docs_update
branch
from
a06df5d to
8a97b6a
Compare
Neudrino
approved these changes
Mar 6, 2023
lucasgonze
pushed a commit
to lucasgonze/magma
that referenced
this pull request
Feb 29, 2024
* docs: Added better instructions for deploying helm charts Added missing environment variable and pointed to example values files. Signed-off-by: Moritz Huebner <[email protected]> * docs: Added missing argument to fluentd secret apply step Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]> * docs: Added `orc8r` in directory structure Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]> * docs: Fixed directory structure Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]> * docs: Improved some more docs Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]> --------- Signed-off-by: Moritz Huebner <[email protected]> Co-authored-by: Sebastian Wolf <[email protected]>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Summary
So far there is no existing documentation of the
cwf-orc8r,feg-orc8r,lte-orc8rhelm charts. The services themselves appear in the docusaurus docs, but there is next to no explanation as to how to actually deploy the helm charts. For someone experienced with kubernetes not much explanation may actually be needed. However, for the average magma developer we should provide some detailed steps as to how to deploy the charts on a local minikube cluster for testing purposes.I added some sentences in the
Deploy on Minikubepage about where to find the helm charts and how to deploy them. Crucially, an environment variable needs to be defined in the values files.Along the way we also found some additional issues:
/orc8rin the a directory nameTest Plan
Following the steps described in the
Deploy on Minikubepage I was able to deploy the charts fororc8r,cwf-orc8r,feg-orc8r, andlte-orc8r.Still to do:
dp-orc8r(Deploy by runningmakein themagma/dpdirectoryfluentdnms