cray Gitea organizationThe Version Control Service (VCS) includes a web interface for repository management, pull requests, and a visual view of all repositories and organizations. The following URL is for the VCS web interface:
https://vcs.ext.system.domain.com
(ncn-mw#) To look up the external system domain name, run the following command:
kubectl get secret site-init -n loftsman -o jsonpath='{.data.customizations\.yaml}' | base64 -d | grep "external:"
Example output:
external: ext.system.domain.com
On cluster nodes, the VCS service can be accessed through the gateway. VCS credentials for the crayvcs user are required before cloning a repository (see
VCS administrative user below).
(ncn#) To clone a repository in the cray organization, use the following command:
git clone https://api-gw-service-nmn.local/vcs/cray/REPO_NAME.git
The Cray System Management (CSM) product installation creates the administrative user crayvcs that is used by CSM and other product installers to import their configuration
content into VCS.
(ncn-mw#) The initial VCS credentials for the crayvcs user are obtained with the following command:
kubectl get secret -n services vcs-user-credentials --template={{.data.vcs_password}} | base64 --decode
The initial VCS login credentials for the crayvcs user are stored in three places:
vcs-user-credentials Kubernetes secret: This is used to initialize the other two locations, as well as providing a place where other users can query for the password.WARNING: These three sources of credentials are not synced by any mechanism. Changing the default password requires that is it changed in all three places. Changing only one may result in difficulty determining the password at a later date, or may result in losing access to VCS altogether.
To change the password in the vcs-user-credentials Kubernetes secret, use the following procedure:
(ncn-mw#) Log in to Keycloak with the default admin credentials.
Point a browser at https://auth.SYSTEM_DOMAIN_NAME/keycloak/admin, replacing SYSTEM_DOMAIN_NAME with the actual NCN’s DNS name.
The following is an example URL for a system: https://auth.cmn.system1.us.cray.com/keycloak/admin
Use the following admin login credentials:
Username: admin
The password can be obtained with the following command:
kubectl get secret -n services keycloak-master-admin-auth \
--template={{.data.password}} | base64 --decode
Ensure the selected Realm is Shasta from the top-left dropdown in the left sidebar.
From the left sidebar, under the Manage section, select Users.
In the Search... textbox, type in crayvcs and click the search icon.
In the filtered table below, click on the ID for the row that shows crayvcs in the Username column.
Go to the Credentials tab and change the password.
Enter the new password in the Reset Password form. Ensure Temporary is switched off. Click on Reset Password button.
Log in to Gitea with the default admin credentials.
Point the browser at https://vcs.SHASTA_CLUSTER_DNS_NAME/vcs/user/settings/account.
If presented with Keycloak login, use crayvcs as the username and the new VCS password. Wait to be redirected to the Gitea login page before continuing to the next step.
Use the following Gitea login credentials:
Username: crayvcs
(ncn-mw#) The old VCS password, which can be obtained with the following command:
kubectl get secret -n services vcs-user-credentials \
--template={{.data.vcs_password}} | base64 --decode
Enter the existing password (from previous step), new password, and confirmation, and then click Update Password.
SSH into ncn-w001 or ncn-m001.
(ncn-mw#) Follow the Redeploying a Chart procedure with the following specifications:
Name of chart to be redeployed: gitea
Base name of manifest: sysmgmt
When reaching the step to update customizations, perform the following steps:
Only follow these steps as part of the previously linked chart redeploy procedure.
Run git clone https://github.com/Cray-HPE/csm.git.
Change the password in the customizations.yaml file.
The Gitea crayvcs password is stored in the vcs-user-credentials Kubernetes Secret in the services namespace. This must be updated so that clients which need to make requests can authenticate with the new password.
In the customizations.yaml file, set the values for the gitea keys in the spec.kubernetes.sealed_secrets field.
The value in the data element where the name is password needs to be changed to the new Gitea password. The section
below will replace the existing sealed secret data in the customizations.yaml file.
For example:
gitea:
generate:
name: vcs-user-credentials
data:
- type: static
args:
name: vcs_password
value: my_secret_password
- type: static
args:
name: vcs_username
value: crayvcs
Encrypt the values after changing the customizations.yaml file.
This command makes use of the
$CUSTOMIZATIONSvariable that is set earlier in the Redeploying a Chart procedure.
./utils/secrets-seed-customizations.sh "${CUSTOMIZATIONS}"
If the above command complains that it cannot find certs/sealed_secrets.crt, then run the following commands to create it:
mkdir -pv ./certs && ./utils/bin/linux/kubeseal --controller-name sealed-secrets --fetch-cert > ./certs/sealed_secrets.crt
When reaching the step to validate that the redeploy was successful, perform the following steps:
Only follow these steps as part of the previously linked chart redeploy procedure.
Verify that the Secret has been updated.
Give the SealedSecret controller a few seconds to update the Secret, then run the following command to see the current value of the Secret:
kubectl get secret -n services vcs-user-credentials --template={{.data.vcs_password}} | base64 --decode
Run a VCS health check.
/usr/local/bin/cmsdev test -q vcs
For more details on this test, including known issues and other command line options, see Software Management Services health checks.
Make sure to perform the entire linked procedure, including the step to save the updated customizations.
cray Gitea organizationThe VCS UI uses Keycloak to authenticate users on the system. However, users from external authentication sources are not automatically associated with permissions in the cray
Gitea organization. As a result, users configured via Keycloak can log in and create organizations and repositories of their own, but they cannot modify the cray organization
that is created during system installation, unless they are given permissions to do so.
The crayvcs Gitea admin user that is created during CSM installation can log in to the UI via Keycloak. To allow users other than crayvcs to have access to repositories in
the cray organization, use the following procedure:
Log in to VCS as the crayvcs user on the system.
URL: https://vcs.SHASTA_CLUSTER_DNS_NAME
Navigate to the cray organization owners page.
URL: https://vcs.SHASTA_CLUSTER_DNS_NAME/vcs/cray/teams/owners
Enter the username of the user who should have access to the organization in the Search user... text field, and click the Add Team Member button.
IMPORTANT The
Ownerrole has full access to all repositories in the organization, as well as administrative access to the organization, including the ability to create and delete repositories.
For granting non-administrative access to the organization and its repositories, create a new team at the following URL:
https://vcs.SHASTA_CLUSTER_DNS_NAME/vcs/org/cray/teams/new
Select the permissions appropriately, and then navigate to the following URL to add members to the newly created team:
https://vcs.SHASTA_CLUSTER_DNS_NAME/vcs/org/cray/teams/NEWTEAM
Data for Gitea is stored in two places: Git content is stored directly in a PVC, while structural data, such as Gitea users and the list and attributes of repositories, is stored in a Postgres database. Because of this, both sources must be backed up and restored together.
(ncn-mw#) Running the following script creates a tar archive containing both the Postgres and PVC data.
The argument to the script is the directory where the resulting archive should be created.
/usr/share/doc/csm/scripts/operations/configuration/backup_vcs.sh /root
The end of the output will include the path to the backup archive. For example:
Gitea/VCS data successfully backed up to /root/gitea-vcs-20240626192742-dRW95b.tgz
Be sure to save the resulting archive file to a safe location.
(ncn-mw#) The archive generated by the Automated backup script can be used as
input to the following automated restore script.
/usr/share/doc/csm/scripts/operations/configuration/restore_vcs.sh /root/gitea-vcs-20240626192742-dRW95b.tgz
(ncn-mw#) Determine which Postgres member is the leader.
kubectl exec gitea-vcs-postgres-0 -n services -c postgres -it -- patronictl list
Example output:
+ Cluster: gitea-vcs-postgres (6995618180238446669) -----+----+-----------+
| Member | Host | Role | State | TL | Lag in MB |
+----------------------+--------------+--------+---------+----+-----------+
| gitea-vcs-postgres-0 | 10.45.0.21 | Leader | running | 1 | |
| gitea-vcs-postgres-1 | 10.46.128.19 | | running | 1 | 0 |
| gitea-vcs-postgres-2 | 10.47.0.21 | | running | 1 | 0 |
+----------------------+--------------+--------+---------+----+-----------+
(ncn-mw#) Log into the leader pod and dump the data to a local file.
POSTGRES_LEADER=gitea-vcs-postgres-0
kubectl exec -it ${POSTGRES_LEADER} -n services -c postgres -- pg_dumpall -c -U postgres > gitea-vcs-postgres.sql
(ncn-mw#) Determine what secrets are associated with the PostgreSQL credentials:
kubectl get secrets -n services | grep gitea-vcs-postgres.credentials
Example output:
postgres.gitea-vcs-postgres.credentials Opaque 2 13d
service-account.gitea-vcs-postgres.credentials Opaque 2 13d
standby.gitea-vcs-postgres.credentials Opaque 2 13d
(ncn-mw#) Export each secret to a manifest file.
The creationTimestamp, resourceVersion, selfLink, and uid metadata fields are removed from each
secret as they are exported.
SECRETS="postgres service-account standby"
tmpfile=$(mktemp)
echo "---" > gitea-vcs-postgres.manifest
for secret in $SECRETS; do
kubectl get secret "${secret}.gitea-vcs-postgres.credentials" -n services -o yaml > "${tmpfile}"
for field in creationTimestamp resourceVersion selfLink uid; do
yq d -i "${tmpfile}" "metadata.${field}"
done
cat "${tmpfile}" >> gitea-vcs-postgres.manifest
echo "---" >> gitea-vcs-postgres.manifest
done
rm "${tmpfile}"
Copy all files to a safe location.
(ncn-mw#) The VCS Postgres backups should be accompanied by backups of the VCS PVC. The export process can be run at any time
while the service is running using the following commands:
POD=$(kubectl -n services get pod -l app.kubernetes.io/instance=gitea -o json | jq -r '.items[] | .metadata.name')
kubectl -n services exec ${POD} -- tar -cvf /tmp/vcs.tar /var/lib/gitea/
kubectl -n services cp ${POD}:/tmp/vcs.tar ./vcs.tar
Be sure to save the resulting tar file to a safe location.
(ncn-mw#) When restoring the VCS Postgres database, the PVC should also be restored to the same point in time. The restore
process can be run at any time while the service is running using the following commands:
POD=$(kubectl -n services get pod -l app.kubernetes.io/instance=gitea -o json | jq -r '.items[] | .metadata.name')
kubectl -n services cp ./vcs.tar ${POD}:/tmp/vcs.tar
kubectl -n services exec ${POD} -- tar -C / -xvf /tmp/vcs.tar
kubectl -n services rollout restart deployment gitea-vcs
An alternative to the separate backups of the Postgres and PVC data is to backup the Git data. This has the advantage that only one backup is needed and that the Git backups can be imported into any Git server, not just Gitea. This has the disadvantage that some information about the Gitea deployment is lost (such as user and organization information) and may need to be recreated manually if the VCS deployment is lost.
The following scripts create and use a vcs-content directory that contains all Git data. This should be copied to a safe location after export, and moved back to the system before import.
WARNING: The following example uses the VCS
adminusername and password in plaintext on the command line, meaning it will be stored in the shell history as well as be visible to all users on the system in the process table. These dangers can be avoided by modifying or replacing thecurlcommand (such as supplying the credentials tocurlusing the--netrc-fileargument instead of the--userargument, or replacing it with a simple Python script).
(ncn-mw#) Use the following commands to do the export:
RESULTS=vcs-content
mkdir $RESULTS
VCS_USER=$(kubectl get secret -n services vcs-user-credentials --template={{.data.vcs_username}} | base64 --decode)
VCS_PASSWORD=$(kubectl get secret -n services vcs-user-credentials --template={{.data.vcs_password}} | base64 --decode)
git config --global credential.helper store
echo "https://${VCS_USER}:${VCS_PASSWORD}@api-gw-service-nmn.local" > ~/.git-credentials
for repo in $(curl -s https://api-gw-service-nmn.local/vcs/api/v1/orgs/cray/repos --user ${VCS_USER}:${VCS_PASSWORD}| jq -r '.[] | .name') ; do
git clone --mirror https://api-gw-service-nmn.local/vcs/cray/${repo}.git
cd ${repo}.git
git bundle create ${repo}.bundle --all
cp ${repo}.bundle ../$RESULTS
cd ..
rm -r $repo.git
done
(ncn-mw#) Use the following commands to do the import:
SOURCE=vcs-content
VCS_USER=$(kubectl get secret -n services vcs-user-credentials --template={{.data.vcs_username}} | base64 --decode)
VCS_PASSWORD=$(kubectl get secret -n services vcs-user-credentials --template={{.data.vcs_password}} | base64 --decode)
git config --global credential.helper store
echo "https://${VCS_USER}:${VCS_PASSWORD}@api-gw-service-nmn.local" > ~/.git-credentials
for file in $(ls $SOURCE); do
repo=$(echo $file | sed 's/.bundle$//')
git clone --mirror ${SOURCE}/${repo}.bundle
cd ${repo}.git
git remote set-url origin https://api-gw-service-nmn.local/vcs/cray/${repo}.git
git push
cd ..
rm -r ${repo}.git
done
Prior to import, the repository structure may need to be recreated if it has not already been by an install.
Adjust the repository list as necessary, if any additional repositories are present. Repository settings such as public or private will also need to be manually set, if applicable.
(ncn-mw#) For example:
WARNING: The following example uses the VCS
adminusername and password in plaintext on the command line, meaning it will be stored in the shell history as well as be visible to all users on the system in the process table. These dangers can be avoided by modifying or replacing thecurlcommand (such as supplying the credentials tocurlusing the--netrc-fileargument instead of the--userargument, or replacing it with a simple Python script).
VCS_USER=$(kubectl get secret -n services vcs-user-credentials --template={{.data.vcs_username}} | base64 --decode)
VCS_PASSWORD=$(kubectl get secret -n services vcs-user-credentials --template={{.data.vcs_password}} | base64 --decode)
REPOS="analytics-config-management cos-config-management cpe-config-management slurm-config-management sma-config-management uan-config-management csm-config-management"
for repo in $REPOS ; do
curl -X POST https://api-gw-service-nmn.local/vcs/api/v1/orgs/cray/repos -u ${VCS_USER}:${VCS_PASSWORD} -d name=${repo}
done