v1.7.0 Release Notes

Zadig v1.7.0 was released on November 16, 2021.

# Feature List

• Support user management
• Support project permission management
• Support external system common links management
• Managed project workflows support Webhook triggered service updates

# Version Upgrade Process

# Upgrade Process for Existing K8s Cluster - High Availability Database

# Step 1: Backup Data

For high availability databases, configure MongoDB full backup through cloud provider.

# Step 2: Uninstall Zadig

1. Download uninstall script(opens new window)
2. Set the namespace to uninstall and execute the uninstall script

export NAMESPACE=<Namespace where Zadig is located>
bash uninstall.sh

# Step 3: Install Zadig v1.7.0

1. Download installation script(opens new window), execute the installation script.

export ENCRYPTION_KEY=<ENCRYPTION_KEY obtained during first installation>
# Configure necessary parameters, refer to [Installation on Existing Kubernetes](/v1.7.1/install/install-on-k8s/)
./install.sh

2. Download data synchronization tool(opens new window), execute upgrade Job.
   1. Modify the last line script value: {{ default "http" .Values.protocol }}://{{- include "zadig.endpoint" . }} to the actual system access domain/IP
   2. Modify mongodb://zadig-mongodb:27017 to the corresponding connection string
   3. Modify zadig in the line below -d to the corresponding dbname
   4. Execute the following command

   kubectl apply -f 1.7.0-upgrade.yaml -n <Zadig namespace>
   

   1
   
3. Ensure Job executes successfully

# Step 4: Verify Installation Results

1. Version information confirmation
   1. Access <Zadig address after installation>/signin
   2. Check the info prompt in the bottom right corner of the login interface, Version information should be 1.7.0
2. New version correctness check, recommended validation points
   1. Administrator accesses any normally used project in the system
   2. Execute workflow to deploy and update services in specified environment
   3. Create integration environment, delete integration environment, update integration environment
   4. Submit code changes, confirm whether workflows with Webhook configured are triggered as expected

# Failure Rollback Process

1. Uninstall Zadig (method Step 2)
2. Reinstall Zadig v1.6.0

Note: Do not enter the system after installation completion, wait for data recovery

3. Rollback data to backup version

# Ensure the operating machine has MongoDB client
# Execute the following command for port forwarding
kubectl port-forward svc/zadig-MongoDB -n <Namespace where Zadig is located> 27090:27017
# Restore data
mongorestore mongodb://localhost:27090 <backup data file/directory>

4. Execute rollback Job
   1. Download data rollback tool(opens new window)
   2. Modify the last line of YAML to actual system access domain/IP
   3. Execute the following command

   kubectl apply -f 1.7.0-revert.yaml -n <Zadig namespace>
   

   1
   

# Upgrade Process for Existing K8s Cluster - Using Zadig Built-in MongoDB

# Step 1: Backup Data

Backup of MongoDB installed by Zadig

# Ensure the operating machine has MongoDB client
# Find Pod name starting with zadig-mongodb, execute the following command for port forwarding
kubectl port-forward svc/zadig-mongodb -n <Namespace where Zadig is located> 27090:27017
# Backup data
mongodump --out=<desired path> --db=zadig mongodb://localhost:27090

# Step 2: Uninstall Zadig

1. Download uninstall script(opens new window)
2. Set the namespace to uninstall and execute the uninstall script

export NAMESPACE=<Namespace where Zadig is located>
bash uninstall.sh

# Step 3: Install Zadig v1.7.0

1. Download installation script(opens new window), execute the installation script.

export ENCRYPTION_KEY=<ENCRYPTION_KEY obtained during first installation>
# Configure necessary parameters, refer to [Installation on Existing Kubernetes](/v1.7.1/install/install-on-k8s/)
./install.sh

2. Ensure Pod status is normal after installation completion (if abnormal, resolve yourself)
3. Restore data to backup version

# Ensure the operating machine has MongoDB client
# Execute the following command to get MongoDB Pod name
kubectl get pods -n <Namespace where Zadig is located>
# Find Pod name starting with zadig-mongodb, execute the following command for port forwarding
kubectl port-forward pod/<Pod name obtained in previous step> -n <Namespace where Zadig is located> 27090:27017
# If using MongoDB installed by Zadig, restore data
mongorestore mongodb://localhost:27090 <backup data file/directory>

4. Download data synchronization tool(opens new window), execute upgrade Job.
   1. Modify the last line script in YAML value: {{ default "http" .Values.protocol }}://{{- include "zadig.endpoint" . }} to actual system access domain/IP
   2. Execute the following command.

   kubectl apply -f 1.7.0-upgrade.yaml -n <Zadig namespace>
   

   1
   
5. Ensure Job executes successfully.

# Step 4: Verify Installation Results

1. Version information confirmation
   1. Access <Zadig address after installation>/signin
   2. Check the info prompt in the bottom right corner of the login interface, Version information should be 1.7.0
2. New version correctness check, recommended validation points
   1. Administrator accesses any normally used project in the system
   2. Execute workflow to deploy and update services in specified environment
   3. Create integration environment, delete integration environment, update integration environment
   4. Submit code changes, confirm whether workflows with Webhook configured are triggered as expected

# Failure Rollback Process

1. Uninstall Zadig (method Step 2)
2. Reinstall Zadig v1.6.0

Note: Do not enter the system after installation completion, wait for data recovery

3. Rollback data to backup version

# Ensure the operating machine has MongoDB client
# Execute the following command for port forwarding
kubectl port-forward svc/zadig-mongodb -n <Namespace where Zadig is located> 27090:27017
# Restore data
mongorestore mongodb://localhost:27090 <backup data file/directory>

4. Execute rollback Job
   1. Download data rollback tool(opens new window)
   2. Modify YAML content according to your Zadig installation method:
      1. Modify the last line to actual system access domain/IP
      2. Modify mongodb://zadig-mongodb:27017 to corresponding connection string
      3. Modify zadig in the line below -d to corresponding dbname
   3. Execute the following command

   kubectl apply -f 1.7.0-revert.yaml -n <Zadig namespace>
   

   1
   

# Upgrade Process for Helm Command - High Availability Database

# Step 1: Backup Data

For high availability databases, configure MongoDB full backup through cloud provider.

# Step 2: Uninstall Zadig

helm list -n <Namespace where Zadig is located> # Get Zadig release name
helm uninstall <release name> -n <Namespace where Zadig is located>

# Step 3: Install Zadig v1.7.0

1. Generate installation command according to Helm Command Generator(opens new window)

(Execute generated Helm installation command) helm install ...

2. Download data synchronization tool(opens new window), execute upgrade Job.
   1. Modify the last line script value: {{ default "http" .Values.protocol }}://{{- include "zadig.endpoint" . }} to actual system access domain/IP
   2. Modify mongodb://zadig-mongodb:27017 to corresponding connection string
   3. Modify zadig in the line below -d to corresponding dbname
   4. Execute the following command

   kubectl apply -f 1.7.0-upgrade.yaml -n <Zadig namespace>
   

   1
   
3. Ensure Job executes successfully

# Step 4: Verify Installation Results

1. Version information confirmation
   1. Access <Zadig address after installation>/signin
   2. Check the info prompt in the bottom right corner of the login interface, Version information should be 1.7.0
2. New version correctness check, recommended validation points
   1. Administrator accesses any normally used project in the system
   2. Execute workflow to deploy and update services in specified environment
   3. Create integration environment, delete integration environment, update integration environment
   4. Submit code changes, confirm whether workflows with Webhook configured are triggered as expected

# Failure Rollback Process

1. Uninstall Zadig (method Step 2)
2. Reinstall Zadig v1.6.0

Note: Do not enter the system after installation completion, wait for data recovery

3. Rollback data to backup version

# Ensure the operating machine has MongoDB client
# Execute the following command for port forwarding
kubectl port-forward svc/zadig-MongoDB -n <Namespace where Zadig is located> 27090:27017
# Restore data
mongorestore mongodb://localhost:27090 <backup data file/directory>

4. Execute rollback Job
   1. Download data rollback tool(opens new window)
   2. Modify the last line of YAML to actual system access domain/IP
   3. Execute the following command

   kubectl apply -f 1.7.0-revert.yaml -n <Zadig namespace>
   

   1
   

# Upgrade Process for Helm Command - Using Zadig Built-in MongoDB

# Step 1: Backup Data

Backup of MongoDB installed by Zadig

# Ensure the operating machine has MongoDB client
# Find Pod name starting with zadig-mongodb, execute the following command for port forwarding
kubectl port-forward svc/zadig-mongodb -n <Namespace where Zadig is located> 27090:27017
# Backup data
mongodump --out=<desired path> --db=zadig mongodb://localhost:27090

# Step 2: Uninstall Zadig

helm list -n <Namespace where Zadig is located> # Get Zadig release name
helm uninstall <release name> -n <Namespace where Zadig is located>

# Step 3: Install Zadig v1.7.0

1. Generate installation command according to Helm Command Generator(opens new window)

(Execute generated Helm installation command) helm install ...

2. Ensure Pod status is normal after installation completion (if abnormal, resolve yourself)
3. Restore data to backup version

# Ensure the operating machine has MongoDB client
# Execute the following command to get MongoDB Pod name
kubectl get pods -n <Namespace where Zadig is located>
# Find Pod name starting with zadig-mongodb, execute the following command for port forwarding
kubectl port-forward pod/<Pod name obtained in previous step> -n <Namespace where Zadig is located> 27090:27017
# If using MongoDB installed by Zadig, restore data
mongorestore mongodb://localhost:27090 <backup data file/directory>

4. Download data synchronization tool(opens new window), execute upgrade Job.
   1. Modify the last line script in YAML value: {{ default "http" .Values.protocol }}://{{- include "zadig.endpoint" . }} to actual system access domain/IP
   2. Execute the following command.

   kubectl apply -f 1.7.0-upgrade.yaml -n <Zadig namespace>
   

   1
   
5. Ensure Job executes successfully.

# Step 4: Verify Installation Results

1. Version information confirmation
   1. Access <Zadig address after installation>/signin
   2. Check the info prompt in the bottom right corner of the login interface, Version information should be 1.7.0
2. New version correctness check, recommended validation points
   1. Administrator accesses any normally used project in the system
   2. Execute workflow to deploy and update services in specified environment
   3. Create integration environment, delete integration environment, update integration environment
   4. Submit code changes, confirm whether workflows with Webhook configured are triggered as expected

# Failure Rollback Process

1. Uninstall Zadig (method Step 2)
2. Reinstall Zadig v1.6.0

Note: Do not enter the system after installation completion, wait for data recovery

3. Rollback data to backup version

# Ensure the operating machine has MongoDB client
# Execute the following command for port forwarding
kubectl port-forward svc/zadig-mongodb -n <Namespace where Zadig is located> 27090:27017
# Restore data
mongorestore mongodb://localhost:27090 <backup data file/directory>

4. Execute rollback Job
   1. Download data rollback tool(opens new window)
   2. Modify YAML content according to your Zadig installation method:
      1. Modify the last line to actual system access domain/IP
      2. Modify mongodb://zadig-mongodb:27017 to corresponding connection string
      3. Modify zadig in the line below -d to corresponding dbname
   3. Execute the following command

   kubectl apply -f 1.7.0-revert.yaml -n <Zadig namespace>
   

   1