Merge remote-tracking branch 'origin/master' into nightly

CHANGELOG.md

@@ -4,6 +4,8 @@ Note: Breaking changes between versions are indicated by "💥".
 
 ## Unreleased
 
+- [Bugfix] Fix `k8s start caddy` command.
+
 ## v13.1.2 (2022-01-30)
 
 - [Bugfix] Fix auto-renewal of certificates revoked by Let's Encrypt (see [discussion](https://community.letsencrypt.org/t/questions-about-renewing-before-tls-alpn-01-revocations/170449/21)).

docs/configuration.rst

@@ -163,7 +163,7 @@ SMTP
 
 - ``RUN_SMTP`` (default: ``true``)
 - ``SMTP_HOST`` (default: ``"smtp"``)
-- ``SMTP_PORT`` (default: ``25``)
+- ``SMTP_PORT`` (default: ``8025``)
 - ``SMTP_USERNAME`` (default: ``""``)
 - ``SMTP_PASSWORD`` (default: ``""``)
 - ``SMTP_USE_TLS`` (default: ``false``)

docs/install.rst

@@ -149,15 +149,10 @@ Uninstallation
 
 It is fairly easy to completely uninstall Tutor and to delete the Open edX platforms that is running locally.
 
-First of all, stop any locally-running platform::
-
-    tutor local stop
-    tutor dev stop
-
-Remove all containers::
+First of all, stop any locally-running platform and remove all Tutor containers::
 
     tutor local dc down --remove-orphans
-    tutor local dc down --remove-orphans
+    tutor dev dc down --remove-orphans
 
 Then, delete all data associated to your Open edX platform::
 

docs/plugins/api.rst

@@ -176,20 +176,28 @@ When saving the environment, template files that are stored in a template root w
 command
 ~~~~~~~
 
-A plugin can provide custom command line commands. Commands are assumed to be `click.Command <https://click.palletsprojects.com/en/8.0.x/api/#commands>`__ objects.
+A plugin can provide custom command line commands. Commands are assumed to be `click.Command <https://click.palletsprojects.com/en/8.0.x/api/#commands>`__ objects, and you typically implement them using the `click.command <https://click.palletsprojects.com/en/8.0.x/api/#click.command>`__ decorator.
+
+You may also use the `click.pass_obj <https://click.palletsprojects.com/en/8.0.x/api/#click.pass_obj>`__ decorator to pass the CLI `context <https://click.palletsprojects.com/en/8.0.x/api/#click.Context>`__, such as when you want to access Tutor configuration settings from your command.
 
 Example::
 
     import click
+    from tutor import config as tutor_config
 
     @click.command(help="I'm a plugin command")
-    def command():
+    @click.pass_obj
+    def command(context):
+        config = tutor_config.load(context.root)
+        lms_host = config["LMS_HOST"]
         click.echo("Hello from myplugin!")
+        click.echo(f"My LMS host is {lms_host}")
 
 Any user who installs the ``myplugin`` plugin can then run::
 
     $ tutor myplugin
     Hello from myplugin!
+    My LMS host is demo.openedx.overhang.io
 
 You can even define subcommands by creating `command groups <https://click.palletsprojects.com/en/8.0.x/api/#click.Group>`__::
 

tutor/templates/kustomization.yml

@@ -30,6 +30,9 @@ configMapGenerator:
 - name: caddy-config
   files:
   - apps/caddy/Caddyfile
+  options:
+    labels:
+        app.kubernetes.io/name: caddy
 - name: openedx-settings-lms
   files:{% for file in "apps/openedx/settings/lms"|walk_templates %}
   - {{ file }}{% endfor %}