-
Notifications
You must be signed in to change notification settings - Fork 28
docs: add a "pack a Pro artifact" how-to #1144
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
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
4efa7ce
docs: migrate "How to pack a Pro rock"
mr-cal b89d5ad
docs: make "how to pack a Pro rock" generic
mr-cal f83f308
Merge branch 'main' into work/CRAFT-5237/pro-docs
mr-cal 9e89e3a
docs: feedback from PR
mr-cal dea9324
docs: feedback from PR
mr-cal 97e3da6
ci: add zizmor workflow
mr-cal fedfaa7
chore(merge): main into work/CRAFT-5237/pro-docs
mr-cal 9e66207
docs: finalize changelog
mr-cal 386d922
ci: ignore .github/instructions
mr-cal 560fd61
Merge branch 'main' into work/CRAFT-5237/pro-docs
mr-cal File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
73 changes: 73 additions & 0 deletions
73
docs/common/craft-application/how-to-guides/pack-a-pro-artifact.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| Pack a Pro-compliant |artifact| | ||
| =============================== | ||
|
|
||
| .. Begin overview | ||
|
|
||
| Follow this guide to pack |an-artifact| that contains extended security patches or meets | ||
| regulatory compliance needs. | ||
|
|
||
| .. End overview | ||
|
|
||
| Prerequisites | ||
| ------------- | ||
|
|
||
| - An Ubuntu Pro system (https://ubuntu.com/pro) | ||
| - LXD version 5.21 or higher installed (https://documentation.ubuntu.com/lxd/) | ||
| - |app| version |app-min-pro-version| or higher installed (|app-link|) | ||
|
|
||
| Enable guest attachment | ||
| ----------------------- | ||
|
|
||
| |app| makes use of Ubuntu Pro’s own support for LXD instances, but this support needs | ||
| to be explicitly enabled and configured. In a terminal, run: | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| sudo pro config set lxd_guest_attach=available | ||
|
|
||
| This command lets |app| attach its LXD instances to the system’s Pro subscription, | ||
| and only needs to be executed once. | ||
|
|
||
| Restart LXD so the new configuration takes effect: | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| sudo snap restart lxd | ||
|
|
||
| Identify the required Pro services | ||
| ---------------------------------- | ||
|
|
||
| Next, determine which Pro services fit your needs. |app| supports the following services: | ||
|
|
||
| - ``esm-apps`` or ``esm-infra``: If your goal is to pack |an-artifact| for an application and | ||
| include the latest security patches for a base that is no longer under Standard Security | ||
| Maintenance. | ||
| - ``fips``, ``fips-updates`` or ``fips-preview``: If you need to deploy |an-artifact| in a | ||
| highly regulated environment that processes sensitive data. | ||
|
|
||
| The desired Pro services must be available. On a system with your Pro token | ||
| attached, run ``pro status`` and check the ``ENTITLED`` column for available | ||
| services. The Ubuntu Pro Client documentation has `detailed information on each service | ||
| <https://documentation.ubuntu.com/pro-client/en/v32/explanations/which_services/>`__. | ||
|
|
||
| Pack the |artifact| | ||
| ------------------- | ||
|
|
||
| Pack your Pro-compliant |artifact| with the ``pack`` command, listing the desired | ||
| services with the ``--pro`` option: | ||
|
|
||
| .. code-block:: bash | ||
| :substitutions: | ||
|
|
||
| |app-command| pack --pro=<service> | ||
|
|
||
| To use multiple services, pass them to the option as comma-separated values. For example, | ||
| to pack |an-artifact| with the ``esm-apps`` and ``esm-infra`` services call: | ||
|
|
||
| .. code-block:: bash | ||
| :substitutions: | ||
|
|
||
| |app-command| pack --pro=esm-apps,esm-infra | ||
|
|
||
| |app| will automatically attach the Pro subscription and enable the requested services on | ||
| the LXD instance while packing the |artifact|. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,6 +7,7 @@ How-to guides | |
| :maxdepth: 1 | ||
|
|
||
| build-remotely | ||
| pack-a-pro-artifact | ||
| partitions | ||
| platforms | ||
| add-a-linter | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| .. meta:: | ||
| :description: Pack an artifact that contains extended security patches or meets regulatory compliance needs, powered by Ubuntu Pro. | ||
|
|
||
| .. |app| replace:: Craft Application | ||
| .. |app-command| replace:: <craft-app> | ||
| .. |artifact| replace:: artifact | ||
| .. |an-artifact| replace:: an artifact | ||
| .. |app-min-pro-version| replace:: 6.3.0 | ||
| .. |app-link| replace:: https://pypi.org/project/craft-application/ | ||
|
|
||
| .. _how-to-pack-a-pro-artifact: | ||
|
|
||
| .. include:: ../common/craft-application/how-to-guides/pack-a-pro-artifact.rst |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.