Skip to content
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

chore(docs): Update tutorial #296

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore(docs): Update tutorial #296

wants to merge 1 commit into from

Conversation

alithethird
Copy link
Contributor

@alithethird alithethird commented Oct 3, 2024

Overview

Standarise the Discourse tutorial with other tutorials and improve/fix the tutorial.

Rationale

Juju Events Changes

Module Changes

Library Changes

Checklist

@alithethird alithethird added documentation Improvements or additions to documentation trivial labels Oct 3, 2024
@alithethird alithethird requested a review from a team as a code owner October 3, 2024 13:51
Copy link
Contributor

github-actions bot commented Oct 3, 2024

Test coverage for 13b5ec1

Name              Stmts   Miss Branch BrPart  Cover   Missing
-------------------------------------------------------------
src/charm.py        373     41     94     15    88%   184, 192-193, 205, 337->345, 378->383, 395, 583-585, 590-591, 603-605, 610-611, 623-625, 648-650, 692->exit, 702->exit, 751-754, 764-765, 789-790, 802-803, 830-832, 834->839, 836-837, 879-880, 896-897, 907->exit, 921
src/database.py      29      1      8      1    95%   56
-------------------------------------------------------------
TOTAL               402     42    102     16    88%

Static code analysis report

Run started:2024-10-03 13:54:05.820766

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 2458
  Total lines skipped (#nosec): 2
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):

juju deploy nginx-ingress-integrator
# If your cluster has RBAC enabled you'll be prompted to run the following:
#If your cluster has RBAC enabled, you'll be prompted to run the following (If you are working inside the Multipass vm, chances are you have RBAC enabled):
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think that adding a way to check for RBAC wouldn't hurt here (microk8s status)


Add the ip address to the /etc/hosts file:
```bash
echo "10.131.49.76 discourse-k8s" >> /etc/hosts
Copy link
Contributor

Choose a reason for hiding this comment

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

I would change this to: echo "10.131.49.76 discourse-k8s" | sudo tee -a /etc/hosts

First get the Multipass instances IP address. Since the indico is served on the local address of the Multipass VM we need to use the ip address of the VM. To get the IP address of a Multipass instance run the following command:

```bash
ip a | awk '/inet .* ens3/{print $2}' | cut -d'/' -f1
Copy link
Contributor

Choose a reason for hiding this comment

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

This will fail in many cases (for example if not using the qemu backend and instead using the lxd backend in multipass). I would use instead:
ip -4 -j route get 2.2.2.2 | jq -r '.[] | .prefsrc'

@@ -10,17 +10,25 @@ In this tutorial, we'll go through each step of the process to get a basic Disco

## Requirements

* A laptop or desktop running Ubuntu (or you can use a VM).
* Juju and [Microk8s](https://juju.is/docs/olm/microk8s) installed. We’ll also want to make sure the ingress add-on is enabled, which we can do by running `microk8s enable ingress`.
- A laptop or desktop running Ubuntu (or you can use a VM).
Copy link
Contributor

@erinecon erinecon Oct 3, 2024

Choose a reason for hiding this comment

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

I would suggest changing this line to "A working station, e.g., a laptop, with amd64 architecture."

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 Libraries: Out of sync trivial
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants