Skip to content

System Options: indicate options that are available only on Ubuntu Core#195

Merged
Mohit-Chachada merged 2 commits intocanonical:mainfrom
Mohit-Chachada:indicate-core-only-system-options
Mar 18, 2026
Merged

System Options: indicate options that are available only on Ubuntu Core#195
Mohit-Chachada merged 2 commits intocanonical:mainfrom
Mohit-Chachada:indicate-core-only-system-options

Conversation

@Mohit-Chachada
Copy link
Contributor

@Mohit-Chachada Mohit-Chachada commented Mar 17, 2026

Copy link
Member

@ernestl ernestl left a comment

Choose a reason for hiding this comment

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

What is the source used to identify UC only options?
I see tests flag read-the-docs build issue.

@Mohit-Chachada
Copy link
Contributor Author

What is the source used to identify UC only options?

For each mentioned system option in the docs, search for the registration of its handler in snapd's overlord/configstate/configcore (mostly here and here). If coreOnlyConfig is set that implies it is available only on UC.

I see tests flag read-the-docs build issue.

Yes, this is an issue already on the main branch of snapd-docs:

SOURCEDIR=docs bash docs/jobs/pre-build-job.sh  
Searching for the latest successful run that has artifact 'openapi-spec'...
Error: Checked the last 100 successful runs, but none contained the artifact 'openapi-spec'.

In summary: the issue is that snapd repo has a workflow which generates an artifact which the build here in snapd-docs uses but the workflow in snapd generates the artifact only when there are actual changes to the docs and currently it happens so that in over the last 100 jobs the artifact was not generated.
I have a discussion planned with @Rnfudge02 today for this.

In the meantime, I have triggered the snapd documentation workflow manually (here), so that it generates the artifact and unblocks the build issue here.

Copy link
Member

@ernestl ernestl left a comment

Choose a reason for hiding this comment

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

Thanks

@Mohit-Chachada
Copy link
Contributor Author

Discussed with @Rnfudge02 regarding some build issues here in snapd-docs:

  1. Github token for gh cli use seems to be not working
  2. Availability of openapi.json artifact from snapd repo is currently not always guaranteed

@Rnfudge02 will look into these issues. For (2) we decided to have a new PR job here in snapd-docs that generates the openapi.json artifact by checking out snapd's latest master branch. Also, the readthedocs build should be triggered after the PR job that generates the artifact

@Mohit-Chachada Mohit-Chachada merged commit 3bdf454 into canonical:main Mar 18, 2026
3 of 4 checks passed
@Mohit-Chachada Mohit-Chachada deleted the indicate-core-only-system-options branch March 18, 2026 15:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants