summaryrefslogtreecommitdiffstats
path: root/bitbake
diff options
context:
space:
mode:
authorAlejandro Hernandez Samaniego <alejandro@enedino.org>2021-02-24 10:26:33 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-03-11 14:04:45 +0000
commit3a60575cba45d484fc9e38d18fead637ad6c5e21 (patch)
treec2fdd7ab03e185fa4820adda5f13efb6d83c8628 /bitbake
parent0f84d24df8b83877b45b5d6aa3eca401b059071e (diff)
downloadpoky-3a60575cba45d484fc9e38d18fead637ad6c5e21.tar.gz
bitbake: docs: Add Az fetcher documentation
(Bitbake rev: e3b480636a3c2716effd619b59cf55e11f9a6db0) Signed-off-by: Alejandro Enedino Hernandez Samaniego <alhe@linux.microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake')
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst28
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst2
2 files changed, 30 insertions, 0 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
index 6760b10828..e9a5f336df 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
@@ -624,6 +624,34 @@ Here are some example URLs: ::
624 SRC_URI = "repo://REPOROOT;protocol=git;branch=some_branch;manifest=my_manifest.xml" 624 SRC_URI = "repo://REPOROOT;protocol=git;branch=some_branch;manifest=my_manifest.xml"
625 SRC_URI = "repo://REPOROOT;protocol=file;branch=some_branch;manifest=my_manifest.xml" 625 SRC_URI = "repo://REPOROOT;protocol=file;branch=some_branch;manifest=my_manifest.xml"
626 626
627.. _az-fetcher:
628
629Az Fetcher (``az://``)
630--------------------------
631
632This submodule fetches data from an
633`Azure Storage account <https://docs.microsoft.com/en-us/azure/storage/>`__ ,
634it inherits its functionality from the HTTP wget fetcher, but modifies its
635behavior to accomodate the usage of a
636`Shared Access Signature (SAS) <https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview>`__
637for non-public data.
638
639Such functionality is set by the variable:
640
641- :term:`AZ_SAS`: The Azure Storage Shared Access Signature provides secure
642 delegate access to resources, if this variable is set, the Az Fetcher will
643 use it when fetching artifacts from the cloud.
644
645You can specify the AZ_SAS variable as shown below: ::
646
647 AZ_SAS = "se=2021-01-01&sp=r&sv=2018-11-09&sr=c&skoid=<skoid>&sig=<signature>"
648
649Here is an example URL: ::
650
651 SRC_URI = "az://<azure-storage-account>.blob.core.windows.net/<foo_container>/<bar_file>"
652
653It can also be used when setting mirrors definitions using the :term:`PREMIRRORS` variable.
654
627Other Fetchers 655Other Fetchers
628-------------- 656--------------
629 657
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
index 6469f9d1a4..1cb4b1d668 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
@@ -1303,6 +1303,8 @@ overview of their function and contents.
1303 - ``svn://`` : Fetches files from a Subversion (``svn``) revision 1303 - ``svn://`` : Fetches files from a Subversion (``svn``) revision
1304 control repository. 1304 control repository.
1305 1305
1306 - ``az://`` : Fetches files from an Azure Storage account using HTTPS.
1307
1306 Here are some additional options worth mentioning: 1308 Here are some additional options worth mentioning:
1307 1309
1308 - ``unpack`` : Controls whether or not to unpack the file if it is 1310 - ``unpack`` : Controls whether or not to unpack the file if it is