@@ -78,12 +78,25 @@ The portal uses GitHub and GitLab API tokens to query repositories, search for
7878` catalog.info ` files and populate the catalog. These tokens expire after a configurable
7979period - generally 3 months. Tokens must be rolled over before this time elapses for the
8080catalog to continue updating, which requires updating the sealed secrets in the values
81- file for the specific deployment. There are two scripts to automate this process. They
81+ file for the specific deployment. There are two scripts to automate this process. They
8282each print an encrypted token that is safe to commit and push to GitHub.
8383
84+ ### Required Tools
85+
86+ This process requires ` xclip ` and ` yq ` .
87+
88+ To install xclip on RHEL:
89+
90+ ``` bash
91+ $ sudo yum install xclip
92+ ```
93+
94+ See the [ yq GitHub repo] ( https://github.com/mikefarah/yq?tab=readme-ov-file#install ) for its install instructions.
95+
96+
8497### GitLab API Token
8598
86- The GitLab API token is maintain under a machine user account and can be rotated via a
99+ The GitLab API token is maintained under a machine user account and can be rotated via a
87100POST request with the existing token. There are separate tokens for dev-portal and
88101dev-portal-dev. The script works for both depending on which cluster is currently
89102active. To rotate the dev-portal token, run
@@ -137,3 +150,11 @@ You can also pass the literal token into the command, but doing it this way mean
137150token can't be saved to your shell history. A space before the command can also prevent the
138151unencrypted token being in your shell history (requires ` HIST_IGNORE_SPACE ` for zsh or
139152` HISTCONTROL=ignorespace ` for bash), but then you can't recall the command.
153+
154+ #### Creating a GitHub Personal Access Token
155+
156+ 1 . Go to user GitHub profile settings
157+ 2 . Left side panel > Developer settings
158+ 3 . Left side panel > Personal access tokens > Tokens (classic)
159+ 4 . Create new token with the required scopes (see Necessary Secrets)
160+ 5 . Copy the token into the script
0 commit comments