docs: update 12-factor tutorials #2085

erinecon · 2025-01-17T15:50:50Z

Update the 12-factor tutorials.

Specific updates:

Convert to reStructuredText
Incorporate feedback from UX session with Daniele
Update all tutorials for consistency (feedback from previous PRs, feedback from Daniele)

lengau · 2025-01-18T02:33:13Z

Hey Erin, I really appreciate this work! Just a note, this is going to conflict with #2083 as it also moves these files to rst. You may want to try to coordinate with @jahn-junior, though I imagine we'll be merging his PR on Monday or Tuesday.

erinecon · 2025-01-20T12:36:15Z

Hey Erin, I really appreciate this work! Just a note, this is going to conflict with #2083 as it also moves these files to rst. You may want to try to coordinate with @jahn-junior, though I imagine we'll be merging his PR on Monday or Tuesday.

Hi @lengau, thanks for letting me know about the other PR. I was under the impression that the 12-factor docs weren't going to be touched since we had planned work to refactor them (See this comment on PR #2010 ). I see there's also #2048 with the how-to guide that I'm planning on refactoring, but that's for a later PR, so I will hold off on that work until after the PR has been merged.

It seems unfortunately that any changes to the Django tutorial might be overwritten by the work in this PR, but I will not touch the FastAPI or Go tutorials until after #2083 has been merged. Thanks again for letting me know.

Fixes canonical#1721 CRAFT-3352

…raft into update-tutorials

lengau · 2025-01-21T16:20:22Z

Hey @erinecon !

On #2048: I'm happy for you to take over that one or to close it unmerged if you want to redo the MD -> rST conversion in your own PR, or we can work together to prioritise the completion so it won't affect you.

Hopefully you should be able to rebase this PR either on #2083 or on main once it's merged and not have too many conflicts.

erinecon · 2025-01-21T17:50:49Z

Hi @lengau , thanks for the offer. I'm fine with waiting for #2048 to be merged before working on a new PR. I appreciate the work you're all doing to convert the files to rST, it saves me a bunch of time! :)

…raft into update-tutorials

lengau · 2025-01-28T22:17:34Z

Thanks for your patience @erinecon ! I've just merged #2083 to main, introducing the conflicts :-)

erinecon · 2025-01-29T12:55:09Z

Thanks @lengau for the update!! I'll get started on resolving the conflicts and making the rest of the planned updates shortly :)

(I'll also turn off the spread tests before marking the PR as ready for review.)

jdkandersson

Thanks for doing the update!

jdkandersson · 2025-02-05T10:37:57Z

docs/tutorial/write-your-first-kubernetes-charm-for-a-django-app.rst

-
-    See more: `Multipass | How to install Multipass
-    <https://multipass.run/docs/install-multipass>`_
+.. include:: /reuse/tutorial/setup_edge.rst


Perhaps we do setup stable now for Django?

jdkandersson · 2025-02-05T10:38:43Z

docs/reuse/tutorial/setup_edge.rst

+
+.. code-block:: bash
+
+    sudo snap install juju --channel 3.5/stable


Should we go with juju version 3.6?

jdkandersson · 2025-02-05T10:39:04Z

docs/reuse/tutorial/setup_stable.rst

-Install Juju and bootstrap a development controller:
+Juju is required to deploy the |12FactorApp| application.
+Install Juju using the ``3.5/stable`` track, and bootstrap a
+development controller:

 .. code-block:: bash

    sudo snap install juju --channel 3.5/stable


Should we go with juju version 3.6?

jdkandersson · 2025-02-05T10:46:29Z

docs/reuse/tutorial/setup_stable.rst

+
+.. code-block:: bash
+
+   sudo microk8s status --wait-ready


I think this can be done after enabling the add-ons for slightly more efficient use of time

jdkandersson · 2025-02-05T11:31:39Z

docs/tutorial/write-your-first-kubernetes-charm-for-a-django-app.rst


-    ALLOWED_HOSTS = json.loads(os.environ.get('DJANGO_ALLOWED_HOSTS', '{ref}`]'))
+   ALLOWED_HOSTS = json.loads(os.environ.get('DJANGO_ALLOWED_HOSTS', '{ref}`]'))


Do you know where the {ref}]` came from? I doubt it would work since it isn't valid JSON

jdkandersson · 2025-02-05T12:13:50Z

docs/tutorial/write-your-first-kubernetes-charm-for-a-django-app.rst

+
+Use ``juju status --watch 2s`` again to wait until the App is active
+again. You may visit http://django-hello-world from a web browser, or
+you can use ``curl 127.0.0.1 -H "Host: django-hello-world"`` inside the


I think we had an alternate way of doing this without the host, curl http://django-hello-world --resolve django-hello-world:80:127.0.0.1 should work

jdkandersson · 2025-02-05T12:14:24Z

docs/tutorial/write-your-first-kubernetes-charm-for-a-django-app.rst

+To demonstrate how to provide a configuration to the Django application,
+we will make the greeting configurable. We will expect this
+configuration option to be available in the Django app configuration under the
+keyword ``GREETING``. Go back out to the rock


This is not correct, that is how it works for Flask but not in Django. In Django, it will be available under the DJANGO_GREETING environment vairable

jdkandersson · 2025-02-05T12:17:13Z

docs/tutorial/write-your-first-kubernetes-charm-for-a-django-app.rst

-greeting.
+After we wait for a bit monitoring ``juju status`` the application
+should go back to ``active`` again. Sending a request to the root
+endpoint using ``curl 127.0.0.1 -H "Host: django-hello-world"`` or


This should also be updated with the above curl command

jdkandersson · 2025-02-05T12:18:26Z

docs/tutorial/write-your-first-kubernetes-charm-for-a-django-app.rst


+After we wait for a moment for the app to be restarted, using
+``curl 127.0.0.1 -H "Host: django-hello-world"`` or visiting


This should also be updated

jdkandersson · 2025-02-05T12:19:39Z

docs/tutorial/write-your-first-kubernetes-charm-for-a-django-app.rst

+- Creating a Django application
+- Deploying the application locally
+- Building an OCI image using Rockcraft
+- Packaging the application using Charmcraft


Is this the intended wording? I would have guessed that packing the application is more like Rockcraft, perhaps bundling the application with ops code using Charmcraft?

erinecon and others added 7 commits January 20, 2025 15:02

docs: remove django md file, add django rst file

2236118

fix: fix lint failures

84f07f9

docs: add django tutorial spread test

04a4817

fix: remove trailing spaces

1e9b7b6

fix: remove trailing spaces

da47d6b

fix(store): better error message with fetch-lib (canonical#2084)

5286e23

Fixes canonical#1721 CRAFT-3352

build(deps): update bugfixes

dc917b1

erinecon force-pushed the update-tutorials branch from da4cfba to dc917b1 Compare January 20, 2025 20:03

erinecon added 5 commits January 20, 2025 15:04

Merge branch 'main' into update-tutorials

65462a4

docs: remove experimental extension flag

7669dea

Merge branch 'update-tutorials' of https://github.com/erinecon/charmc…

ae603d9

…raft into update-tutorials

docs: add reuse setup file

f3fd4b7

docs: replace code with wrapped commands

92ac018

fix: remove duplicate content, break commands up

659b28d

erinecon changed the title ~~update 12-factor tutorials~~ docs: update 12-factor tutorials Jan 21, 2025

erinecon added 11 commits January 22, 2025 08:44

Merge branch 'main' into update-tutorials

69eb47d

fix: incorporate changes from Design team

d28c88e

Merge branch 'main' into update-tutorials

fd27611

fix: revert command to run app locally

5514ed9

Merge branch 'update-tutorials' of https://github.com/erinecon/charmc…

ae67ad0

…raft into update-tutorials

fix: update Django spread test

4b4a684

Merge branch 'main' into update-tutorials

ac11344

docs: update Django pack warning

9046167

docs: update Django charm pack warning

bdc53c2

fix: update Flask task file

ecd8773

docs: update Flask tutorial files

2991bf5

erinecon added 4 commits January 24, 2025 12:06

test: force juju snap refresh

0d7ce15

fix: add substitutions to setup

9f34fe1

Merge branch 'main' into update-tutorials

1d28cd3

fix: make lint happy

a1badee

erinecon added 22 commits January 29, 2025 08:57

Merge branch 'main' into update-tutorials

62b982f

docs: update flask tutorial title

48905f8

docs: update flask tutorial title

e2dacd4

fix: sync Flask and Django tutorials

06385cc

test: update spread.yaml

030bad6

docs: update fastapi tutorial

8699139

test: update flask spread test

5019f95

docs: update fastapi tutorial

7d8b696

docs: update fastapi tutorial

0036d3a

test: pin postgres revision in flask spread test

2edc394

fix: remove trailing whitespace

483ec4b

Merge branch 'main' into update-tutorials

3f9dd67

fix: update tutorial index

79462b1

fix: update fastapi tutorial

7e0a28f

fix: revert postgres pin and turn off spread

508ea85

test: output spread software versions

85af6c1

docs: update go tutorial

0a7a486

docs: update go tutorial

486b146

fix: make lint happy

41ef9df

fix: update reusable setups

968734c

fix: correct issues with go tutorial

d66f8b3

test: remove checks in flask spread

4864aa0

jdkandersson reviewed Feb 5, 2025

View reviewed changes

Merge branch 'main' into update-tutorials

d7f1774

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: update 12-factor tutorials #2085

docs: update 12-factor tutorials #2085

erinecon commented Jan 17, 2025

lengau commented Jan 18, 2025

erinecon commented Jan 20, 2025

lengau commented Jan 21, 2025

erinecon commented Jan 21, 2025

lengau commented Jan 28, 2025

erinecon commented Jan 29, 2025

jdkandersson left a comment

jdkandersson Feb 5, 2025

jdkandersson Feb 5, 2025

jdkandersson Feb 5, 2025

jdkandersson Feb 5, 2025

jdkandersson Feb 5, 2025

jdkandersson Feb 5, 2025

jdkandersson Feb 5, 2025

jdkandersson Feb 5, 2025

jdkandersson Feb 5, 2025

jdkandersson Feb 5, 2025


		.. code-block:: bash

		sudo snap install juju --channel 3.5/stable


		ALLOWED_HOSTS = json.loads(os.environ.get('DJANGO_ALLOWED_HOSTS', '{ref}`]'))
		ALLOWED_HOSTS = json.loads(os.environ.get('DJANGO_ALLOWED_HOSTS', '{ref}`]'))


		After we wait for a moment for the app to be restarted, using
		``curl 127.0.0.1 -H "Host: django-hello-world"`` or visiting

docs: update 12-factor tutorials #2085

Are you sure you want to change the base?

docs: update 12-factor tutorials #2085

Conversation

erinecon commented Jan 17, 2025

lengau commented Jan 18, 2025

erinecon commented Jan 20, 2025

lengau commented Jan 21, 2025

erinecon commented Jan 21, 2025

lengau commented Jan 28, 2025

erinecon commented Jan 29, 2025

jdkandersson left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment