Skip to content

docs: update Redis deployment guidance - #786

Open
miachillgood wants to merge 1 commit into
canonical:mainfrom
miachillgood:codex/update-redis-tutorial
Open

docs: update Redis deployment guidance#786
miachillgood wants to merge 1 commit into
canonical:mainfrom
miachillgood:codex/update-redis-tutorial

Conversation

@miachillgood

Copy link
Copy Markdown

Applicable spec: N/A — documentation correction tracked by #782

Overview

Updates the tutorial and integration reference to deploy one redis-k8s application and integrate it once with Indico. That matches the charm's single Redis relation and the current integration tests.

Closes #782

Rationale

The documentation still instructed users to deploy separate redis-broker and redis-cache applications. Following those steps conflicts with the current charm interface and causes the tutorial to diverge from tested deployment behavior.

Juju Events Changes

None.

Module Changes

None.

Library Changes

None.

Checklist

ISD054 does not apply because there are no charm-code changes. This is a focused correction already categorized as trivial and no-release-note on #782; maintainers can apply the corresponding PR labels. No changelog or change artifact is needed for the documentation-only correction.

Validation performed:

  • Confirmed charmcraft.yaml exposes one Redis relation with limit 1
  • Confirmed integration tests deploy and integrate one Redis application
  • Confirmed the updated pages contain no remaining redis-broker or redis-cache instructions
  • Ran git diff --check

@miachillgood
miachillgood requested a review from a team as a code owner September 1, 2026 23:40
@miachillgood
miachillgood requested review from minulo and srbouffard and removed request for a team September 1, 2026 23:40
@erinecon erinecon added the documentation Improvements or additions to documentation label Sep 2, 2026
@erinecon
erinecon self-requested a review September 2, 2026 11:31
@erinecon erinecon added trivial no-release-note This PR does not require a change artifact labels Sep 2, 2026

@erinecon erinecon left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thank you so much for updating our documentation 🎉 I spotted a nit and also ran into an issue when trying out the tutorial myself

Comment thread docs/tutorial.md
Since Indico requires connections to PostgreSQL and Redis, you'll deploy them too. For more information, see [Charm Architecture](https://charmhub.io/indico/docs/explanation-charm-architecture).

Redis is deployed twice because one is for the broker and the other for the cache. To do this, the `juju deploy` command accepts an extra argument with the custom application name. See more details in [`juju deploy`](https://canonical.com/juju/docs/juju-cli/3.6/reference/juju-cli/list-of-juju-cli-commands/deploy/).
Since Indico requires connections to PostgreSQL and Redis, you'll deploy them too. A single Redis application provides both caching and the Celery message broker. For more information, see [Charm Architecture](https://charmhub.io/indico/docs/explanation-charm-architecture).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Since Indico requires connections to PostgreSQL and Redis, you'll deploy them too. A single Redis application provides both caching and the Celery message broker. For more information, see [Charm Architecture](https://charmhub.io/indico/docs/explanation-charm-architecture).
Indico requires connections to PostgreSQL and Redis. A single Redis application provides both caching and the Celery message broker. For more information, see [Charm Architecture](https://charmhub.io/indico/docs/explanation-charm-architecture).

nit, for conciseness

Comment thread docs/tutorial.md
```
juju integrate indico:redis-broker redis-broker
juju integrate indico:redis-cache redis-cache
juju integrate indico redis-k8s

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I ran into an error when trying this command:

ubuntu@charm-tutorial-vm:~$ juju integrate indico redis-k8s
ERROR ambiguous relation: "indico redis-k8s" could refer to "indico:redis-broker redis-k8s:redis"; "indico:redis-cache redis-k8s:redis"

So I think we still need two juju integrate commands, but for a single redis-k8s charm:

Suggested change
juju integrate indico redis-k8s
juju integrate indico:redis-broker redis-k8s
juju integrate indico:redis-cache redis-k8s

command --> commands in the text above, and if you want, you could also add some text pointing out that we must explicitly use two different relation endpoints so that the Redis charm can provide both capabilities.

@erinecon

erinecon commented Sep 3, 2026

Copy link
Copy Markdown
Collaborator

Hi @miachillgood , thanks for opening this PR! I just noticed that your commit is not signed. This is a requirement for merging PRs into this repository (see the contributing guidelines).

You'll either need to retroactively sign your commits in this PR, or close the PR and reopen with signed commits. Please let me know if you need any help or have any questions!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation no-release-note This PR does not require a change artifact trivial

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Tutorial used outdated info

2 participants