Skip to content

Commit 712a8b2

Browse files
committed
added a docs note
1 parent c0d8e1b commit 712a8b2

2 files changed

Lines changed: 8 additions & 5 deletions

File tree

docs/modules/airflow/examples/example-airflow-gitsync-https.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ spec:
2222
--rev: HEAD # <10>
2323
# --rev: git-sync-tag # N.B. tag must be covered by "depth" (the number of commits to clone)
2424
# --rev: 39ee3598bd9946a1d958a448c9f7d3774d7a8043 # N.B. commit must be covered by "depth"
25-
--git-config: http.sslCAInfo:/tmp/ca-cert/ca.crt # <11>
25+
# --git-config: http.sslCAInfo:/tmp/ca-cert/ca.crt # N.B. this will trigger a warning if caCertSecretName is also supplied
26+
caCertSecretName: git-ca-cert # <11>
2627
webservers:
2728
...
2829
---

docs/modules/airflow/pages/usage-guide/mounting-dags.adoc

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,12 @@ include::example$example-airflow-gitsync-https.yaml[]
6565
This should include two fields: `user` and `password` (which can be either a password -- which is not recommended -- or a GitHub token, as described https://github.com/kubernetes/git-sync/tree/v3.6.4#flags-which-configure-authentication[here])
6666
<9> A map of optional configuration settings that are listed in https://github.com/kubernetes/git-sync/tree/v4.2.1?tab=readme-ov-file#manual[this] configuration section (and the ones that follow on that link)
6767
<10> An example showing how to specify a target revision (the default is HEAD).
68-
The revision can also be a tag or a commit, though this assumes that the target hash is contained within the number of commits specified by `depth`.
69-
If a tag or commit hash is specified, then git-sync recognizes this and does not perform further cloning.
70-
<11> Git-sync settings can be provided inline, although some of these (`--dest`, `--root`) are specified internally in the operator and are ignored if provided by the user.
71-
Git-config settings can also be specified, although a warning is logged if `safe.directory` is specified as this is defined internally, and should not be defined by the user.
68+
The revision can also be a tag or a commit, though this assumes that the target hash is contained within the number of commits specified by `depth`.
69+
If a tag or commit hash is specified, then git-sync recognizes this and does not perform further cloning.
70+
Git-sync settings can be provided inline, although some of these (`--dest`, `--root`) are specified internally in the operator and are ignored if provided by the user.
71+
Git-config settings can also be specified, although a warning is logged if `safe.directory` is specified as this is defined internally, and should not be defined by the user.
72+
<11> An optional secret used for holding CA certificates that will be used to verify the git server's TLS certificate by passing it to the git config option `http.sslCAInfo` passed with the gitsync command.
73+
The secret must have a key named `ca.crt` whose value is the PEM-encoded certificate bundle.
7274

7375
.git-sync usage example: ssh
7476
[source,yaml]

0 commit comments

Comments
 (0)