Skip to content

Commit 63a8a44

Browse files
committed
Update docs
Signed-off-by: JeffMboya <jangina.mboya@gmail.com>
1 parent f600ea9 commit 63a8a44

File tree

1 file changed

+25
-27
lines changed

1 file changed

+25
-27
lines changed

docs/kubernetes.md

Lines changed: 25 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -302,41 +302,39 @@ For more examples, refer to this [Postman Collection](https://elements.getpostma
302302
Here's a **clean, complete, and production-ready update** of your SuperMQ installation documentation that incorporates:
303303

304304
- **How to add the SuperMQ chart as a dependency in a parent chart** using an OCI registry.
305-
- **Clarifies** the `harbor.example.com` placeholder.
305+
- **Clarifies** the `supermq.example.com` placeholder.
306306
- **Follows best practices** from Helm 3.8+ OCI documentation.
307307
- **Emphasizes clarity** and self-containment.
308308

309309
---
310310

311311
### Installing SuperMQ from Published Chart
312312

313-
SuperMQ Helm charts are published to a secure, private **OCI registry** hosted on **Harbor**. This installation method is recommended for production and CI/CD pipelines, supporting authentication, RBAC, signed charts, and versioned releases.
313+
SuperMQ Helm charts are published to a secure, private **OCI registry**. This installation method is recommended for production and CI/CD pipelines, supporting authentication, RBAC, signed charts, and versioned releases.
314314

315-
#### 1. Authenticate with Harbor
315+
#### 1. Authenticate with Private OCI registry
316316

317-
Use your Harbor username/password or robot account credentials:
317+
Use your Private OCI registry username/password:
318318

319319
```bash
320-
helm registry login harbor.example.com
320+
helm registry login supermq.example.com
321321
```
322322

323-
> **Note:** Replace `harbor.example.com` with your actual Harbor domain (e.g., `harbor.acme.io`, `harbor.internal.company.net`, etc.).
324-
325-
For a full guide on Helm OCI registries, refer to [Working with Helm OCI Charts (Harbor docs)](https://goharbor.io/docs/2.12.0/working-with-projects/working-with-oci/working-with-helm-oci-charts/).
323+
> **Note:** Replace `supermq.example.com` with your actual Private OCI registry domain.
326324
327325
#### 2. Install the Chart (Choose One Option)
328326

329327
##### 🔹 Option A — Pull and install locally:
330328

331329
```bash
332-
helm pull oci://harbor.example.com/supermq/supermq --version 0.16.7
330+
helm pull oci://supermq.example.com/supermq/supermq --version 0.16.7
333331
helm install supermq ./supermq-0.16.7.tgz -n smq
334332
```
335333

336334
##### 🔹 Option B — Install directly from OCI:
337335

338336
```bash
339-
helm install supermq oci://harbor.example.com/supermq/supermq \
337+
helm install supermq oci://supermq.example.com/supermq/supermq \
340338
--version 0.16.7 \
341339
-f custom-values.yaml \
342340
-n smq
@@ -353,7 +351,7 @@ kubectl get pods -n smq
353351

354352
### Adding SuperMQ as a Dependency in a Parent Chart
355353

356-
If you're building a **parent Helm chart** (e.g. `magistrala`) and want to include SuperMQ as a dependency from your Harbor OCI registry, follow these steps:
354+
If you're building a **parent Helm chart** (e.g. `magistrala`) and want to include SuperMQ as a dependency from your Private OCI registry, follow these steps:
357355

358356
#### 1. Define the Dependency in `Chart.yaml`
359357

@@ -363,15 +361,15 @@ Update your `Chart.yaml` in the parent chart directory:
363361
dependencies:
364362
- name: supermq
365363
version: "0.16.7"
366-
repository: "oci://harbor.example.com/supermq"
364+
repository: "oci://supermq.example.com/supermq"
367365
```
368366
369-
> Be sure to replace `harbor.example.com` with your actual Harbor domain.
367+
> Be sure to replace `supermq.example.com` with your actual Private OCI registry domain.
370368

371-
#### 2. Authenticate with Harbor (if not already done)
369+
#### 2. Authenticate with Private OCI registry (if not already done)
372370

373371
```bash
374-
helm registry login harbor.example.com
372+
helm registry login supermq.example.com
375373
```
376374

377375
#### 3. Download Dependencies
@@ -426,9 +424,9 @@ kubectl get pods -n <namespace>
426424

427425
---
428426

429-
## Publishing SuperMQ to Harbor (OCI Registry)
427+
## Publishing SuperMQ to Private OCI registry (OCI Registry)
430428

431-
To publish the SuperMQ chart to a Harbor-based OCI registry, follow these steps:
429+
To publish the SuperMQ chart to a Private OCI registry follow these steps:
432430

433431
### 1. Package the Chart
434432

@@ -447,42 +445,42 @@ supermq-0.16.7.tgz
447445
> **Note:** If you want to override the version defined in `Chart.yaml`, you can use the `--version` flag, for example:
448446
> `helm package . --version 0.16.8`
449447

450-
### 2. Authenticate with Harbor (if not already logged in)
448+
### 2. Authenticate with Private OCI registry (if not already logged in)
451449

452450
```bash
453-
helm registry login harbor.example.com
451+
helm registry login supermq.example.com
454452
```
455453

456-
> **Note:** Replace `harbor.example.com` with your actual Harbor domain or IP address.
454+
> **Note:** Replace `supermq.example.com` with your actual Private OCI registry domain or IP address.
457455

458456
---
459457

460-
### 3. Push the Chart to Harbor
458+
### 3. Push the Chart to Private OCI registry
461459

462460
```bash
463-
helm push supermq-0.16.7.tgz oci://harbor.example.com/supermq
461+
helm push supermq-0.16.7.tgz oci://supermq.example.com/supermq
464462
```
465463

466464
If successful, you'll see:
467465

468466
```
469-
Pushed: harbor.example.com/supermq/supermq:0.16.7
467+
Pushed: supermq.example.com/supermq/supermq:0.16.7
470468
Digest: sha256:<hash>
471469
```
472470

473-
> **Note:** Make sure the **project (`supermq`) exists** in Harbor before pushing, or the push will fail.
471+
> **Note:** Make sure the **project (`supermq`) exists** in Private OCI registry before pushing, or the push will fail.
474472

475473
---
476474

477475
### 4. (Optional) Verify the Chart Exists
478476

479-
You can browse Harbor's web UI or use the Helm CLI to pull or inspect the chart:
477+
You can browse Private OCI registry's web UI or use the Helm CLI to pull or inspect the chart:
480478

481479
```bash
482-
helm show chart oci://harbor.example.com/supermq/supermq --version 0.16.7
480+
helm show chart oci://supermq.example.com/supermq/supermq --version 0.16.7
483481
```
484482

485-
> **Note:** Replace `harbor.example.com` with your actual Harbor domain or IP address.
483+
> **Note:** Replace `supermq.example.com` with your actual Private OCI registry domain or IP address.
486484

487485
---
488486

0 commit comments

Comments
 (0)