docs: add howto guides for switching from the charm plugin #1967

lengau · 2024-10-17T20:25:23Z

This adds howto guides to switch from the charm plugin to the python and poetry plugins.

mattculler

Very clear!

jnsgruk · 2024-10-18T09:39:12Z

Gave this a go here: jnsgruk/zinc-k8s-operator#288

Might be worth including a section about using override-pull as a place where people can generate requirements'txt if they need to.

I guess they could also use override-build and just place their generation code before craftctl default.

Edit: lots of failed integration tests when I changed to this; will investigate.

jnsgruk · 2024-10-18T10:31:40Z

Heh. The python plugin doesn't seem to have included any dispatch file...

ubuntu@ubuntu-noble-2e39:~/zinc_charm_unzipped$ ls -la
total 39480
drwxrwxr-x 5 ubuntu ubuntu     4096 Oct 18 10:30 .
drwxr-xr-x 9 ubuntu ubuntu     4096 Oct 18 10:30 ..
drwxrwxr-x 2 ubuntu ubuntu     4096 Oct 18 10:30 bin
drwxrwxr-x 3 ubuntu ubuntu     4096 Oct 18 10:30 lib
drwxrwxr-x 3 ubuntu ubuntu     4096 Oct 18 10:30 lib64
-rw-r--r-- 1 ubuntu ubuntu      255 Oct 18 10:21 manifest.yaml
-rw-r--r-- 1 ubuntu ubuntu     1402 Oct 18 10:21 metadata.yaml
-rw-r--r-- 1 ubuntu ubuntu      169 Oct 18 10:21 pyvenv.cfg

Edit: switched to the latest/edge channel and things seem better:

ubuntu@ubuntu-noble-2e39:~/data/code/charms/zinc-k8s-operator$ unzip -l ./zinc-k8s_amd64.charm | grep -v python3
Archive:  ./zinc-k8s_amd64.charm
  Length      Date    Time    Name
---------  ---------- -----   ----
      272  2024-10-18 10:38   manifest.yaml
     1402  2024-10-18 10:38   metadata.yaml
      673  2024-10-18 10:38   dispatch
      188  2024-10-18 10:34   venv/pyvenv.cfg
     2680  2024-10-03 08:44   src/zinc.py
     3922  2024-10-03 08:44   src/charm.py
        0  2022-05-31 14:57   src/prometheus_alert_rules/.gitkeep
      294  2022-07-30 20:33   src/prometheus_alert_rules/zinc_missing.rule
        0  2022-05-31 14:57   src/loki_alert_rules/.gitkeep
    20957  2023-08-23 13:19   src/grafana_dashboards/zinc.json.tmpl
    99854  2024-08-19 14:12   lib/charms/loki_k8s/v0/loki_push_api.py
    30560  2024-08-28 16:53   lib/charms/traefik_k8s/v2/ingress.py
    96662  2024-08-19 14:12   lib/charms/prometheus_k8s/v0/prometheus_scrape.py
    34280  2024-10-02 08:52   lib/charms/parca/v0/parca_scrape.py
    80536  2024-08-19 14:12   lib/charms/grafana_k8s/v0/grafana_dashboard.py
     9975  2024-10-02 08:52   lib/charms/observability_libs/v0/juju_topology.py
---------                     -------
 41499875                     2412 files

Alas, no dice on deploying, though...

ubuntu@ubuntu-noble-2e39:~/zinc_charm/venv$ juju debug-log
unit-zinc-k8s-0: 10:39:59 WARNING unit.zinc-k8s/0.install ln: failed to create symbolic link '/var/lib/juju/agents/unit-zinc-k8s-0/charm/venv/bin/python': No such file or directory
unit-zinc-k8s-0: 10:39:59 WARNING unit.zinc-k8s/0.install /var/lib/juju/agents/unit-zinc-k8s-0/charm/dispatch: 16: exec: /var/lib/juju/agents/unit-zinc-k8s-0/charm/venv/bin/python: not found
unit-zinc-k8s-0: 10:39:59 ERROR juju.worker.uniter.operation hook "install" (via hook dispatching script: dispatch) failed: exit status 127

lengau · 2024-10-18T15:01:34Z

Thanks @jnsgruk! Looks like I forgot to test with python-keep-bins: false (the default). I've made a fix PR, but as a temporary workaround you should also be able to set python-keep-bins: true in the part definition.

lengau · 2024-10-18T15:04:21Z

@jnsgruk re: the override-pull - while people could do that, I'd prefer not to document it here as I'd like to encourage people to check in some sort of lock file. For the uv case, @bepri is heading up our addition of uv plugins for 25.04

medubelko

Thanks for putting these together!

docs/howto/charm-to-python.rst

medubelko · 2024-10-18T19:02:45Z

docs/howto/charm-to-poetry.rst

@@ -0,0 +1,107 @@
+.. _howto-migrate-to-poetry:
+
+Migrate from the ``charm`` plugin to Poetry


For consistency with existing docs and docs best practices, we should use the form Charm plugin and Python plugin.

docs/howto/charm-to-poetry.rst

medubelko · 2024-10-18T19:30:20Z

docs/howto/charm-to-python.rst

+Migrate from the ``charm`` plugin to the ``python`` plugin
+==========================================================
+
+The ``python`` Charmcraft plugin offers a faster, stricter means of packing an operator


Charmcraft plugin

Do we need to be this specific here? "Python Charmcraft plugin" tripped me up as a phrase.

Yes, because it works slightly differently from the Rockcraft plugin, the Snapcraft plugin, etc.

docs/howto/charm-to-python.rst

Co-authored-by: Michael DuBelko <michael.dubelko@gmail.com>

medubelko · 2024-11-01T11:17:35Z

docs/howto/charm-to-poetry.rst

+Select compatible versions of ``pip`` and ``poetry``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The ``poetry`` plugin requires at least pip 22.3, released in October 2022. If the


Suggested change

The ``poetry`` plugin requires at least pip 22.3, released in October 2022. If the

The Poetry plugin requires at least `pip 22.3

<https://pypi.org/project/pip/22.3>`_, released in October 2022. If the

medubelko · 2024-11-01T11:18:56Z

docs/howto/charm-to-poetry.rst

+Include extra files
+-------------------
+
+A ``poetry`` plugin only includes the contents of the ``src`` and ``lib`` directories


Suggested change

A ``poetry`` plugin only includes the contents of the ``src`` and ``lib`` directories

A Poetry plugin only includes the contents of the ``src`` and ``lib`` directories

medubelko · 2024-11-01T11:19:40Z

docs/howto/charm-to-python.rst

+Migrate from the Charm plugin to the Python plugin
+==================================================
+
+The Python Charmcraft plugin offers a faster, stricter means of packing an operator


Suggested change

The Python Charmcraft plugin offers a faster, stricter means of packing an operator

The Python plugin in Charmcraft offers a faster, stricter means of packing an operator

lengau requested review from medubelko and a team October 17, 2024 20:25

lengau linked an issue Oct 17, 2024 that may be closed by this pull request

Document the python and poetry plugins #1913

Open

docs: add howto guides for switching from the charm plugin

1347d86

This adds howto guides to switch from the charm plugin to the python and poetry plugins.

lengau force-pushed the work/1913/CRAFT-3425/howto branch from 95567bd to 1347d86 Compare October 17, 2024 22:22

mattculler approved these changes Oct 18, 2024

View reviewed changes

jnsgruk mentioned this pull request Oct 18, 2024

build: migrate to the python plugin jnsgruk/zinc-k8s-operator#288

Draft

medubelko requested changes Oct 18, 2024

View reviewed changes

lengau and others added 2 commits November 1, 2024 10:50

fix: pr suggestionts

03973e0

Co-authored-by: Michael DuBelko <michael.dubelko@gmail.com>

fix: pr suggestions

d1a83c6

lengau requested a review from medubelko November 1, 2024 10:12

Merge branch 'main' into work/1913/CRAFT-3425/howto

78e2829

medubelko requested changes Nov 1, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add howto guides for switching from the charm plugin #1967

docs: add howto guides for switching from the charm plugin #1967

lengau commented Oct 17, 2024

mattculler left a comment

jnsgruk commented Oct 18, 2024 •

edited

Loading

jnsgruk commented Oct 18, 2024 •

edited

Loading

lengau commented Oct 18, 2024

lengau commented Oct 18, 2024

medubelko left a comment

medubelko Oct 18, 2024

lengau Nov 1, 2024

medubelko Oct 18, 2024

lengau Oct 21, 2024

medubelko Nov 1, 2024

medubelko Nov 1, 2024

medubelko Nov 1, 2024

		@@ -0,0 +1,107 @@
		.. _howto-migrate-to-poetry:

		Migrate from the ``charm`` plugin to Poetry

	The ``poetry`` plugin requires at least pip 22.3, released in October 2022. If the
	The Poetry plugin requires at least `pip 22.3
	<https://pypi.org/project/pip/22.3>`_, released in October 2022. If the

	A ``poetry`` plugin only includes the contents of the ``src`` and ``lib`` directories
	A Poetry plugin only includes the contents of the ``src`` and ``lib`` directories

	The Python Charmcraft plugin offers a faster, stricter means of packing an operator
	The Python plugin in Charmcraft offers a faster, stricter means of packing an operator

docs: add howto guides for switching from the charm plugin #1967

Are you sure you want to change the base?

docs: add howto guides for switching from the charm plugin #1967

Conversation

lengau commented Oct 17, 2024

mattculler left a comment

Choose a reason for hiding this comment

jnsgruk commented Oct 18, 2024 • edited Loading

jnsgruk commented Oct 18, 2024 • edited Loading

lengau commented Oct 18, 2024

lengau commented Oct 18, 2024

medubelko left a comment

Choose a reason for hiding this comment

medubelko Oct 18, 2024

Choose a reason for hiding this comment

lengau Nov 1, 2024

Choose a reason for hiding this comment

medubelko Oct 18, 2024

Choose a reason for hiding this comment

lengau Oct 21, 2024

Choose a reason for hiding this comment

medubelko Nov 1, 2024

Choose a reason for hiding this comment

medubelko Nov 1, 2024

Choose a reason for hiding this comment

medubelko Nov 1, 2024

Choose a reason for hiding this comment

jnsgruk commented Oct 18, 2024 •

edited

Loading

jnsgruk commented Oct 18, 2024 •

edited

Loading