Skip to content

patch(DPE-10924): k8s upgrades docs - #857

Open
smethnani wants to merge 4 commits into
2/edgefrom
DPE-10924-k8s-upgrades-docs
Open

smethnani wants to merge 4 commits into
2/edgefrom
DPE-10924-k8s-upgrades-docs

Conversation

@smethnani

Copy link
Copy Markdown
Contributor

Adds upgrades on K8s docs

I moved the "recover from rollback" section to VM only as it hasn't been tested on K8s

@smethnani smethnani changed the title Dpe 10924 k8s upgrades docs patch(DPE-10924): k8s upgrades docs Sep 11, 2026

@izmalk izmalk left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good. I've made a few suggestions and a question about K8s Juju scaling.

Comment thread docs/how-to/upgrade.md
:sync: k8s

```shell
juju add-unit opensearch-k8s

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Question: Is it the same add-unit in K8s? I thought we have to use juju scale-application instead.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

It's what I've been using with k8s but I can see the juju docs do suggest scale-application. But they also say remove-unit <unit> works for k8s which doesn't (it needs to be just the application name with --num-units <n> or juju will complain) :/ I'll switch both to scale-application

Comment thread docs/how-to/upgrade.md
Comment on lines +235 to +238
Charmed OpenSearch supports performance profiles with different RAM consumption:

* `production`: JVM heap set to 50% of the available RAM, capped at 31 GB
* `testing`: JVM heap fixed at ~1 GB of RAM

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggestion: This part is exactly the same and has specific numbers. Let's move it outside of the tabs, so we won't need to duplicate it.

@smethnani smethnani Sep 16, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Ah I was trying to avoid the revision part in k8s. I think it makes sense to move it to the next section's vm tab as I don't believe the k8s section needs this warning.

Comment thread docs/how-to/upgrade.md
:sync: k8s

```shell
juju remove-unit opensearch-k8s --num-units 1

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Question: Same question about juju scale-application.

Comment thread docs/how-to/upgrade.md
[OpenSearch documentation about rolling upgrades](https://docs.opensearch.org/latest/migrate-or-upgrade/rolling-upgrade/#preparing-to-upgrade).

### Check Juju status
**Check Juju status**

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggestion: This is a big section below. And there is no alternative for K8s. I feel like we can drop the tabs here, for this section, and just add a warning at the start that K8s don't support this. That way we avoid sacrificing the convenience of proper headings and navigation for just having an almost empty K8s tab.

Comment thread README.md
[![Charmhub](https://charmhub.io/opensearch/badge.svg)](https://charmhub.io/opensearch)
[![Release](https://github.com/canonical/opensearch-operator/actions/workflows/release.yaml/badge.svg)](https://github.com/canonical/opensearch-operator/actions/workflows/release.yaml)
[![Tests](https://github.com/canonical/opensearch-operator/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/canonical/opensearch-operator/actions/workflows/ci.yaml)
[![Docs](https://github.com/canonical/opensearch-operator/actions/workflows/sync_docs.yaml/badge.svg)](https://github.com/canonical/opensearch-operator/actions/workflows/sync_docs.yaml)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

praise: Thanks for fixing it.

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.

2 participants