SiegfriedSiegert/PTU5KAS
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add environment variable SSH_PRIVATE_KEY_FILE

Browse Source 
Additionally to the variable SSH_PRIVATE_KEY, which can be used to
reference a private key saved as a string within a variable (the previous
documentation falsely stated, that it references a path and has been
adjusted), the new variable SSH_PRIVATE_KEY_FILE can now be used to reference
the path to a file containing the private key.

Signed-off-by: Jasper Orschulko <jasper@fancydomain.eu>
[Jan: Fix logic for detecting set env vars]
Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
This commit is contained in:
Jasper Orschulko
2021-07-03 23:35:40 +02:00
committed by Jan Kiszka
parent 4d2b16e04d
commit 15de0142d4
3 changed files with 105 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files

134
docs/command-line.rst
View File

@@ -10,67 +10,79 @@ Command line usage
Environment variables
---------------------
+-----------------------+-----------------------------------------------------+
| Environment variables | Description |
+=======================+=====================================================+
| ``KAS_WORK_DIR`` | The path of the kas work directory, current work |
| | directory is the default. |
+-----------------------+-----------------------------------------------------+
| ``KAS_BUILD_DIR`` | The path build directory, ``${KAS_WORK_DIR}/build`` |
| | is the default. |
+-----------------------+-----------------------------------------------------+
| ``KAS_REPO_REF_DIR`` | The path to the repository reference directory. |
| | Repositories in this directory are used as |
| | references when cloning. In order for kas to find |
| | those repositories, they have to be named in a |
| | specific way. The repo URLs are translated like |
| | this: "https://github.com/siemens/meta-iot2000.git" |
| | resolves to the name |
| | "github.com.siemens.meta-iot2000.git". |
+-----------------------+-----------------------------------------------------+
| ``KAS_DISTRO`` | This overwrites the respective setting in the |
| ``KAS_MACHINE`` | configuration file. |
| ``KAS_TARGET`` | |
| ``KAS_TASK`` | |
+-----------------------+-----------------------------------------------------+
| ``KAS_PREMIRRORS`` | Specifies alternatives for repo URLs. Just like |
| | bitbake ``PREMIRRORS``, this variable consists of |
| | new-line separated entries. Each entry defines a |
| | regular expression to match a URL and, space- |
| | separated, its replacement. E.g.: |
| | "https://.*\.somehost\.io/ https://localmirror.net/"|
+-----------------------+-----------------------------------------------------+
| ``SSH_PRIVATE_KEY`` | Path to the private key file that should be added |
| | to an internal ssh-agent. This key cannot be |
| | password protected. This setting is useful for CI |
| | build servers. On desktop machines, an ssh-agent |
| | running outside the kas environment is more useful. |
+-----------------------+-----------------------------------------------------+
| ``SSH_AUTH_SOCK`` | SSH authentication socket. Used for cloning over |
| | SSH (alternative to ``SSH_PRIVATE_KEY``). |
+-----------------------+-----------------------------------------------------+
| ``DL_DIR`` | Environment variables that are transferred to the |
| ``SSTATE_DIR`` | bitbake environment. |
| ``TMPDIR`` | |
+-----------------------+-----------------------------------------------------+
| ``http_proxy`` | This overwrites the proxy configuration in the |
| ``https_proxy`` | configuration file. |
| ``ftp_proxy`` | |
| ``no_proxy`` | |
+-----------------------+-----------------------------------------------------+
| ``GIT_PROXY_COMMAND`` | Set proxy for native git fetches. ``NO_PROXY`` is |
| ``NO_PROXY`` | evaluated by OpenEmbedded's oe-git-proxy script. |
+-----------------------+-----------------------------------------------------+
| ``SHELL`` | The shell to start when using the `shell` plugin. |
+-----------------------+-----------------------------------------------------+
| ``TERM`` | The terminal options used in the `shell` plugin. |
+-----------------------+-----------------------------------------------------+
| ``AWS_CONFIG_FILE`` | Path to the awscli configuration and credentials |
| |aws_cred| | file that are copied to the kas home dir. |
+-----------------------+-----------------------------------------------------+
| |git_cred| | Allows to set the git credential helper in the |
| | `.gitconfig` of the kas user. |
+-----------------------+-----------------------------------------------------+
+--------------------------+--------------------------------------------------+
| Environment variables | Description |
+==========================+==================================================+
| ``KAS_WORK_DIR`` | The path of the kas work directory, current work |
| | directory is the default. |
+--------------------------+--------------------------------------------------+
| ``KAS_BUILD_DIR`` | The path build directory, |
| | ``${KAS_WORK_DIR}/build`` is the default. |
+--------------------------+--------------------------------------------------+
| ``KAS_REPO_REF_DIR`` | The path to the repository reference directory. |
| | Repositories in this directory are used as |
| | references when cloning. In order for kas to |
| | find those repositories, they have to be named |
| | in a specific way. The repo URLs are translated |
| | like this: |
| | "https://github.com/siemens/meta-iot2000.git" |
| | resolves to the name |
| | "github.com.siemens.meta-iot2000.git". |
+--------------------------+--------------------------------------------------+
| ``KAS_DISTRO`` | This overwrites the respective setting in the |
| ``KAS_MACHINE`` | configuration file. |
| ``KAS_TARGET`` | |
| ``KAS_TASK`` | |
+--------------------------+--------------------------------------------------+
| ``KAS_PREMIRRORS`` | Specifies alternatives for repo URLs. Just like |
| | bitbake ``PREMIRRORS``, this variable consists |
| | of new-line separated entries. Each entry |
| | defines a regular expression to match a URL and, |
| | space-separated, its replacement. E.g.: |
| | "http://.*\.someurl\.io/ http://localmirror.net/"|
+--------------------------+--------------------------------------------------+
| ``SSH_PRIVATE_KEY`` | Variable containing the private key that should |
| | be added to an internal ssh-agent. This key |
| | cannot be password protected. This setting is |
| | useful for CI build servers. On desktop |
| | machines, an ssh-agent running outside the kas |
| | environment is more useful. |
+--------------------------+--------------------------------------------------+
| ``SSH_PRIVATE_KEY_FILE`` | Path to the private key file that should be |
| | added to an internal ssh-agent. This key cannot |
| | be password protected. This setting is useful |
| | for CI build servers. On desktop machines, an |
| | ssh-agent running outside the kas environment is |
| | more useful. |
+--------------------------+--------------------------------------------------+
| ``SSH_AUTH_SOCK`` | SSH authentication socket. Used for cloning over |
| | SSH (alternative to ``SSH_PRIVATE_KEY`` or |
| | ``SSH_PRIVATE_KEY_FILE``). |
+--------------------------+--------------------------------------------------+
| ``DL_DIR`` | Environment variables that are transferred to |
| ``SSTATE_DIR`` | the bitbake environment. |
| ``TMPDIR`` | |
+--------------------------+--------------------------------------------------+
| ``http_proxy`` | This overwrites the proxy configuration in the |
| ``https_proxy`` | configuration file. |
| ``ftp_proxy`` | |
| ``no_proxy`` | |
+--------------------------+--------------------------------------------------+
| ``GIT_PROXY_COMMAND`` | Set proxy for native git fetches. ``NO_PROXY`` |
| ``NO_PROXY`` | is evaluated by OpenEmbedded's oe-git-proxy |
| | script. |
+--------------------------+--------------------------------------------------+
| ``SHELL`` | The shell to start when using the `shell` |
| | plugin. |
+--------------------------+--------------------------------------------------+
| ``TERM`` | The terminal options used in the `shell` plugin. |
+--------------------------+--------------------------------------------------+
| ``AWS_CONFIG_FILE`` | Path to the awscli configuration and credentials |
| |aws_cred| | file that are copied to the kas home dir. |
+--------------------------+--------------------------------------------------+
| |git_cred| | Allows to set the git credential helper in the |
| | `.gitconfig` of the kas user. |
+--------------------------+--------------------------------------------------+
.. |aws_cred| replace:: ``AWS_SHARED_CREDENTIALS_FILE``
.. |git_cred| replace:: ``GIT_CREDENTIAL_HELPER``