Browse Source

add comments & ntoe (#5248)

Signed-off-by: Niels ten Boom <nielstenboom@gmail.com>
Co-authored-by: Gergely Brautigam <skarlso777@gmail.com>
Niels ten Boom 7 months ago
parent
commit
f410c1ace1

+ 1 - 0
docs/api/generator/github.md

@@ -52,3 +52,4 @@ After installation, you need to get the installation ID to authenticate API requ
 ### Notes
 ### Notes
 - Ensure that all sensitive data such as private keys and IDs are securely handled and stored.
 - Ensure that all sensitive data such as private keys and IDs are securely handled and stored.
 - Adjust the permissions and configurations according to your specific requirements and security policies.
 - Adjust the permissions and configurations according to your specific requirements and security policies.
+- Github tokens expire after 60 minutes by default and this is non-configurable, make sure you choose a refreshInterval that is below this number.

+ 1 - 1
docs/snippets/generator-github-example-basicauth.yaml

@@ -10,7 +10,7 @@ spec:
         apiVersion: generators.external-secrets.io/v1alpha1
         apiVersion: generators.external-secrets.io/v1alpha1
         kind: GithubAccessToken
         kind: GithubAccessToken
         name: github-auth-token
         name: github-auth-token
-  refreshInterval: "15m"
+  refreshInterval: "15m" # Be sure to set this value lower than 60m since that is the expiration time from github
   target:
   target:
     template:
     template:
       metadata:
       metadata:

+ 1 - 1
docs/snippets/generator-github-example.yaml

@@ -4,7 +4,7 @@ kind: ExternalSecret
 metadata:
 metadata:
   name: github-auth-token
   name: github-auth-token
 spec:
 spec:
-  refreshInterval: "30m"
+  refreshInterval: "30m" # Be sure to set this value lower than 60m since that is the expiration time from github
   target:
   target:
     name: github-auth-token # Name for the secret to be created on the cluster
     name: github-auth-token # Name for the secret to be created on the cluster
   dataFrom:
   dataFrom: