kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity
gitlab-org--gitlab-foss/doc/ci/secure_files/index.md

2.9 KiB
Raw Blame History

stage group info type
Verify Pipeline Authoring To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments reference

Project-level Secure Files (FREE)

Introduced in GitLab 14.8. Deployed behind the ci_secure_files flag, disabled by default.

FLAG: On self-managed GitLab, by default this feature is not available. To make it available, ask an administrator to enable the feature flag named ci_secure_files. Limited to 100 secure files per project. Files must be smaller than 5 MB. The feature is not ready for production use.

You can securely store files for use in CI/CD pipelines as "secure files". These files are stored securely outside of your project's repository, and are not version controlled. It is safe to store sensitive information in these files. Secure files support both plain text and binary file types.

You can manage secure files in the project settings, or with the secure files API.

Secure files can be downloaded and used by CI/CD jobs by using the load-secure-files tool.

NOTE: This feature is in active development and is likely to change, potentially in a breaking way. Additional features and capabilities are planned.

Add a secure file to a project

To add a secure file to a project:

  1. On the top bar, select Menu > Projects and find your project.
  2. On the left sidebar, select Settings > CI/CD.
  3. In the Secure Files section, select Manage.
  4. Select Upload File.
  5. Find the file to upload, select Open, and the file upload begins immediately. The file shows up in the list when the upload is complete.

Use secure files in CI/CD jobs

To use your secure files in a CI/CD job, you must use the load-secure-files tool to download the files in the job. After they are downloaded, you can use them with your other script commands.

Add a command in the script section of your job to download the load-secure-files tool and execute it. The files download into a .secure_files directory in the root of the project. To change the download location for the secure files, set the path in the SECURE_FILES_DOWNLOAD_PATH CI/CD variable.

For example:

test:
  variables:
    SECURE_FILES_DOWNLOAD_PATH: './where/files/should/go/'
  script:
    - curl --silent "https://gitlab.com/gitlab-org/incubation-engineering/devops-for-mobile-apps/load-secure-files/-/raw/main/installer" | bash