Skip to content

MG-57 - Update Kubernetes Development Guide with Latest Enhancements #18

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
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

JeffMboya
Copy link
Contributor

@JeffMboya JeffMboya commented Feb 3, 2025

What does this do?

  • Clarifies Helm behavior when re.secrets.names is defined as an empty list
  • Adds YAML examples and corrected template logic
  • Documents registry auth, namespace termination cleanup, and RE email configuration paths
  • Replaces outdated links with magistrala-devops references
  • Adds complete SenML format validation guidance to Rules Engine docs

Which issue(s) does this PR fix/relate to?

List any changes that modify/break current functionality

None

Have you included tests for your changes?

No

Did you document any new/modified functionality?

No

Notes

@JeffMboya JeffMboya marked this pull request as ready for review April 8, 2025 09:39
@dborovcanin
Copy link
Contributor

@JeffMboya Please rebase

@JeffMboya JeffMboya force-pushed the updatedocs branch 2 times, most recently from d91c5dc to 963cd4a Compare April 14, 2025 06:47
@arvindh123 arvindh123 moved this to 🩺 Review and testing in SuperMQ Apr 15, 2025
@JeffMboya JeffMboya changed the title NOISSUE - Enhance k8s docs MG-57 - Update Kubernetes Development Guide with Latest Enhancements May 6, 2025
@JeffMboya JeffMboya removed this from SuperMQ May 6, 2025

This means:

* `re.secrets.names` is **set** but **empty** (`[]`).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use hyphens for unordered lists instead.


That logic **fails when `re.secrets.names: []` is present**, because:

* The block for `envFrom` renders **nothing**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use hyphens or dashes for this list as well.

After deploying Magistrala, verify the services and pods using `kubectl` commands:
Once the chart is installed, you can verify that Magistrala is running correctly:

#### View all resources in the `mg` namespace:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the colons from headings. This results in a trailing punctuation lint error.

Add step to remove finalizers

Update docs

Signed-off-by: JeffMboya <[email protected]>

Add loki installation verification

Signed-off-by: JeffMboya <[email protected]>

Add log viewing using grafana

Signed-off-by: JeffMboya <[email protected]>

Rename mg to smq

Signed-off-by: JeffMboya <[email protected]>

Update docs

Signed-off-by: JeffMboya <[email protected]>

Document harbor

Signed-off-by: JeffMboya <[email protected]>

Rename supermq to Magistrala

Signed-off-by: JeffMboya <[email protected]>

Update docs

Signed-off-by: JeffMboya <[email protected]>

Update docs

Signed-off-by: JeffMboya <[email protected]>

Update docs

Signed-off-by: JeffMboya <[email protected]>

Update docs

Signed-off-by: JeffMboya <[email protected]>

Document RE email config handling

Signed-off-by: JeffMboya <[email protected]>

Update dosc

Signed-off-by: JeffMboya <[email protected]>

Address comments

Signed-off-by: JeffMboya <[email protected]>

Address comments

Signed-off-by: JeffMboya <[email protected]>

Address comments

Signed-off-by: JeffMboya <[email protected]>

Address comments

Signed-off-by: JeffMboya <[email protected]>

Address comments

Signed-off-by: JeffMboya <[email protected]>

Address comments

Signed-off-by: JeffMboya <[email protected]>

Update docs/dev-guide/kubernetes.md

Co-authored-by: Nataly Musilah <[email protected]>

Update docs/dev-guide/kubernetes.md

Co-authored-by: Nataly Musilah <[email protected]>

Update docs/dev-guide/kubernetes.md

Co-authored-by: Nataly Musilah <[email protected]>
Signed-off-by: JeffMboya <[email protected]>

Topic:

```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```
```bash


Becomes:

```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```
```bash


This means:

* MQTT `/` separators are rewritten as `.` internally
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use hyphens for unordered lists

Signed-off-by: JeffMboya <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature: Update Kubernetes Development Guide with Latest Enhancements
4 participants