docs: Add doc for custom repos. #426

cpuguy83 · 2024-11-06T00:20:54Z

sozercan · 2024-11-06T01:19:39Z

website/docs/examples/repos/msft-azl-cloud-native.yml.md

+                skip_if_unavailable=True
+                sslverify=1
+      envs:
+        # The repositgory will only be available when installing into the final container


Suggested change

# The repositgory will only be available when installing into the final container

# The repository will only be available when installing into the final container

sozercan · 2024-11-06T01:19:55Z

website/docs/examples/repos/msft-ubuntu.yml.md

+    msft-golang:
+  extra_repos:
+    - keys:
+        msft.gpg: # Note: This must currenlty use a `.gpg` suffix or apt will not be happy


Suggested change

msft.gpg: # Note: This must currenlty use a `.gpg` suffix or apt will not be happy

msft.gpg: # Note: This must currently use a `.gpg` suffix or apt will not be happy

sozercan · 2024-11-06T01:21:03Z

website/docs/spec.md

+Sometimes you may need to add extra repositories in order to fulfill the
+specified dependencies.
+You can do this by adding these to the `extra_repos` field.
+The `extra_repos` field takes a list of repositoriy configurations with optional


Suggested change

The `extra_repos` field takes a list of repositoriy configurations with optional

The `extra_repos` field takes a list of repository configurations with optional

sozercan · 2024-11-06T01:22:06Z

website/docs/examples/repos/msft-ubuntu.yml.md

+              # Note the `signed-by` path is always going to be `/usr/share/keyrings/<source key name>` for Ubuntu
+              contents: deb [arch=amd64,arm64,armhf signed-by=/usr/share/keyrings/msft.gpg] https://packages.microsoft.com/ubuntu/22.04/prod jammy main
+      envs:
+        # The repositgory will only be available when installing build dependencies


Suggested change

# The repositgory will only be available when installing build dependencies

# The repository will only be available when installing build dependencies

sozercan · 2024-11-06T01:23:02Z

website/docs/spec.md

+        - install # Makes the repo(s) available when preparing the container (runtime dependencies)
+```
+
+See [reporitories](repositories.md) for more details on repository configs


Suggested change

See [reporitories](repositories.md) for more details on repository configs

See [repositories](repositories.md) for more details on repository configs

adamperlin · 2024-11-06T01:32:41Z

website/docs/spec.md

+  extra_repos:
+    - config:
+      # source for repo config
+      # This is the data that would go into /etc/yum.repos.d or /etc/apt/sources.list.d, as an example.


can you add an actual key here such as foo.repo and/or foo.list so that it fits with the schema?

I did not add specific examples here because I have real examples/details in the repositories.md.
The intent here was to just show the structure.
Since this is going to be completely different depending on the distro I was thinking this would be better.
Alternatively I was thinking we could remove the example config and just point at the more detailed document.

I do like the idea of just pointing at the more detailed document here to alleviate any confusion!

Cool, I just removed the yaml block here.

adamperlin · 2024-11-06T01:34:22Z

website/docs/examples/repos/msft-ubuntu.yml.md

+        microsoft-prod.list:
+          inline:
+            file:
+              # Note the `signed-by` path is always going to be `/usr/share/keyrings/<source key name>` for Ubuntu


Suggested change

# Note the `signed-by` path is always going to be `/usr/share/keyrings/<source key name>` for Ubuntu

# Note the `signed-by` path is always going to be `/usr/share/keyrings/<source key name>` for Ubuntu, in this case our source key name is `msft.gpg`

DannyBrito · 2024-11-06T15:55:26Z

website/docs/repositories.md

+repository config you can use the `extra_repos` field in the [dependencies
+section](spec#dependencies-section) section to inject extra repositories at


Suggested change

repository config you can use the `extra_repos` field in the [dependencies

section](spec#dependencies-section) section to inject extra repositories at

repository config you can use the `extra_repos` field in the [dependencies

section](spec#dependencies-section) to inject extra repositories at

DannyBrito · 2024-11-06T15:55:29Z

website/docs/repositories.md

+When you need to reference packages from repositories not in the worker's
+repository config you can use the `extra_repos` field in the [dependencies
+section](spec#dependencies-section) section to inject extra repositories at
+the right time so those dependencies can be satisified.


Suggested change

the right time so those dependencies can be satisified.

the right time so those dependencies can be satisfied.

DannyBrito · 2024-11-06T15:55:32Z

website/docs/repositories.md

+
+

two empty lines

Suggested change

DannyBrito · 2024-11-06T15:55:35Z

website/docs/repositories.md

+  This may include files or other resources that are essential for certain
+  configurations—especially file-backed repositories that need data not already
+  available in the environment. The content of this is a mount which takes


Could you please reword this? I am not sure I understand the part of certain configurations—especially
Maybe something like:

Suggested change

This may include files or other resources that are essential for certain

configurations—especially file-backed repositories that need data not already

available in the environment. The content of this is a mount which takes

This may include files or other resources essential for certain configurations,

particularly file-backed repositories that need data not already available in the

environment. The content of this is a mount which takes.

DannyBrito · 2024-11-06T15:55:39Z

website/docs/repositories.md

+  available in the environment. The content of this is a mount which takes
+  a `dest` field for where the content should be mounted in the build env and a
+  `spec` field, the content of which is a [source](sources.md) just like in the
+  sources section. Usage of `data` is considered an andvanced case and, aside


Suggested change

sources section. Usage of `data` is considered an andvanced case and, aside

sources section. Usage of `data` is considered an advanced case and, aside

Signed-off-by: Brian Goff <[email protected]>

cpuguy83 · 2024-11-06T18:44:32Z

All the feedback should be addressed now.

cpuguy83 · 2024-11-07T18:36:34Z

Updated this with all the requested changes.

cpuguy83 requested a review from adamperlin November 6, 2024 00:20

cpuguy83 requested a review from a team as a code owner November 6, 2024 00:20

sozercan reviewed Nov 6, 2024

View reviewed changes

adamperlin reviewed Nov 6, 2024

View reviewed changes

cpuguy83 force-pushed the custom_repo_docs branch from 1247fe4 to cf2f9dc Compare November 6, 2024 15:49

DannyBrito reviewed Nov 6, 2024

View reviewed changes

cpuguy83 force-pushed the custom_repo_docs branch from cf2f9dc to 56dbc6f Compare November 6, 2024 16:08

docs: Add doc for custom repos.

6b7bed9

Signed-off-by: Brian Goff <[email protected]>

cpuguy83 force-pushed the custom_repo_docs branch from 56dbc6f to 6b7bed9 Compare November 6, 2024 18:43

sozercan approved these changes Nov 7, 2024

View reviewed changes

cpuguy83 requested review from DannyBrito and adamperlin November 7, 2024 19:57

DannyBrito approved these changes Nov 11, 2024

View reviewed changes

cpuguy83 merged commit c2a1f17 into Azure:main Nov 12, 2024
5 checks passed

cpuguy83 deleted the custom_repo_docs branch November 12, 2024 18:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Add doc for custom repos. #426

docs: Add doc for custom repos. #426

cpuguy83 commented Nov 6, 2024 •

edited

Loading

sozercan Nov 6, 2024

sozercan Nov 6, 2024

sozercan Nov 6, 2024

sozercan Nov 6, 2024

sozercan Nov 6, 2024

adamperlin Nov 6, 2024

cpuguy83 Nov 6, 2024

adamperlin Nov 6, 2024

cpuguy83 Nov 6, 2024

adamperlin Nov 6, 2024

DannyBrito Nov 6, 2024

DannyBrito Nov 6, 2024

DannyBrito Nov 6, 2024

DannyBrito Nov 6, 2024

DannyBrito Nov 6, 2024

cpuguy83 commented Nov 6, 2024

cpuguy83 commented Nov 7, 2024

	# The repositgory will only be available when installing into the final container
	# The repository will only be available when installing into the final container

	msft.gpg: # Note: This must currenlty use a `.gpg` suffix or apt will not be happy
	msft.gpg: # Note: This must currently use a `.gpg` suffix or apt will not be happy

	The `extra_repos` field takes a list of repositoriy configurations with optional
	The `extra_repos` field takes a list of repository configurations with optional

	See [reporitories](repositories.md) for more details on repository configs
	See [repositories](repositories.md) for more details on repository configs

	# Note the `signed-by` path is always going to be `/usr/share/keyrings/<source key name>` for Ubuntu
	# Note the `signed-by` path is always going to be `/usr/share/keyrings/<source key name>` for Ubuntu, in this case our source key name is `msft.gpg`

		repository config you can use the `extra_repos` field in the [dependencies
		section](spec#dependencies-section) section to inject extra repositories at

	the right time so those dependencies can be satisified.
	the right time so those dependencies can be satisfied.

	sources section. Usage of `data` is considered an andvanced case and, aside
	sources section. Usage of `data` is considered an advanced case and, aside

docs: Add doc for custom repos. #426

docs: Add doc for custom repos. #426

Conversation

cpuguy83 commented Nov 6, 2024 • edited Loading

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

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

cpuguy83 commented Nov 6, 2024

cpuguy83 commented Nov 7, 2024

cpuguy83 commented Nov 6, 2024 •

edited

Loading