From e3b480636a3c2716effd619b59cf55e11f9a6db0 Mon Sep 17 00:00:00 2001 From: Alejandro Hernandez Samaniego Date: Wed, 24 Feb 2021 10:26:33 -0700 Subject: docs: Add Az fetcher documentation Signed-off-by: Alejandro Enedino Hernandez Samaniego Signed-off-by: Richard Purdie --- .../bitbake-user-manual-fetching.rst | 28 ++++++++++++++++++++++ .../bitbake-user-manual-ref-variables.rst | 2 ++ 2 files changed, 30 insertions(+) diff --git a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst index 6760b1082..e9a5f336d 100644 --- a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst +++ b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst @@ -624,6 +624,34 @@ Here are some example URLs: :: SRC_URI = "repo://REPOROOT;protocol=git;branch=some_branch;manifest=my_manifest.xml" SRC_URI = "repo://REPOROOT;protocol=file;branch=some_branch;manifest=my_manifest.xml" +.. _az-fetcher: + +Az Fetcher (``az://``) +-------------------------- + +This submodule fetches data from an +`Azure Storage account `__ , +it inherits its functionality from the HTTP wget fetcher, but modifies its +behavior to accomodate the usage of a +`Shared Access Signature (SAS) `__ +for non-public data. + +Such functionality is set by the variable: + +- :term:`AZ_SAS`: The Azure Storage Shared Access Signature provides secure + delegate access to resources, if this variable is set, the Az Fetcher will + use it when fetching artifacts from the cloud. + +You can specify the AZ_SAS variable as shown below: :: + + AZ_SAS = "se=2021-01-01&sp=r&sv=2018-11-09&sr=c&skoid=&sig=" + +Here is an example URL: :: + + SRC_URI = "az://.blob.core.windows.net//" + +It can also be used when setting mirrors definitions using the :term:`PREMIRRORS` variable. + Other Fetchers -------------- diff --git a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst index 6469f9d1a..1cb4b1d66 100644 --- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst @@ -1303,6 +1303,8 @@ overview of their function and contents. - ``svn://`` : Fetches files from a Subversion (``svn``) revision control repository. + - ``az://`` : Fetches files from an Azure Storage account using HTTPS. + Here are some additional options worth mentioning: - ``unpack`` : Controls whether or not to unpack the file if it is -- cgit 1.2.3-korg