summaryrefslogtreecommitdiffstats
path: root/bitbake/doc
diff options
context:
space:
mode:
Diffstat (limited to 'bitbake/doc')
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst36
1 files changed, 36 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 c061bd70ea..f5723d6767 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
@@ -688,6 +688,40 @@ Here is an example URL::
688 688
689It can also be used when setting mirrors definitions using the :term:`PREMIRRORS` variable. 689It can also be used when setting mirrors definitions using the :term:`PREMIRRORS` variable.
690 690
691.. _gcp-fetcher:
692
693GCP Fetcher (``gs://``)
694--------------------------
695
696This submodule fetches data from a
697`Google Cloud Storage Bucket <https://cloud.google.com/storage/docs/buckets>`__.
698It uses the `Google Cloud Storage Python Client <https://cloud.google.com/python/docs/reference/storage/latest>`__
699to check the status of objects in the bucket and download them.
700The use of the Python client makes it substantially faster than using command
701line tools such as gsutil.
702
703The fetcher requires the Google Cloud Storage Python Client to be installed, along
704with the gsutil tool.
705
706The fetcher requires that the machine has valid credentials for accessing the
707chosen bucket. Instructions for authentication can be found in the
708`Google Cloud documentation <https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev>`__.
709
710The fetcher can be used for fetching sstate artifacts from a GCS bucket by
711specifying the :term:`SSTATE_MIRRORS` variable as shown below::
712
713 SSTATE_MIRRORS ?= "\
714 file://.* gs://<bucket name>/PATH \
715 "
716
717The fetcher can also be used in recipes::
718
719 SRC_URI = "gs://<bucket name>/<foo_container>/<bar_file>"
720
721However, the checksum of the file should be also be provided::
722
723 SRC_URI[sha256sum] = "<sha256 string>"
724
691.. _crate-fetcher: 725.. _crate-fetcher:
692 726
693Crate Fetcher (``crate://``) 727Crate Fetcher (``crate://``)
@@ -791,6 +825,8 @@ Fetch submodules also exist for the following:
791 825
792- OSC (``osc://``) 826- OSC (``osc://``)
793 827
828- S3 (``s3://``)
829
794- Secure FTP (``sftp://``) 830- Secure FTP (``sftp://``)
795 831
796- Secure Shell (``ssh://``) 832- Secure Shell (``ssh://``)