Automated Operation and Maintenance of ohpm-repo in HarmonyOS Next: Batch Management and Data Migration

In the enterprise-level development of HarmonyOS Next, the automated operation and maintenance of the ohpm-repo private repository is the key to improving development efficiency and ensuring the stable operation of projects. By implementing functions such as batch management and data migration, the operation and maintenance efficiency can be greatly improved, and the cost of manual operations can be reduced. Now, let's discuss in detail how to achieve these automated operation and maintenance goals.

How to Export and Migrate the Data of the Existing Repository?

Use ohpm-repo export_pkginfo to Export the Information of Listed Packages

The export_pkginfo command provided by ohpm-repo can export the list of packages that have been listed in ohpm-repo or the OpenHarmony third-party library central repository to the pkgInfo_xxx.json file in the current directory. If you want to export from the OpenHarmony third-party library central repository, you need to specify the --public-registry parameter. The example is as follows:

ohpm-repo export_pkginfo --public-registry <registry address of the OpenHarmony third-party library central repository>

After executing this command, the pkgInfo_xxx.json file will contain detailed information about all the listed packages, providing a basis for subsequent data migration and batch operations.

How to Manually Modify pkgInfo_xxx.json to Download Only Specified Packages

The pkgInfo_xxx.json file is a JSON-formatted file that contains information such as the package name, version, and organization. If we only need to download some specified packages, we can manually edit this file and delete the information of the packages that are not needed. For example, only keep the entries of the required packages, as shown below:

[
    {
        "name": "@ohos/some-package",
        "version": "1.0.0",
        "organization": "your-org"
    },
    {
        "name": "@ohos/another-package",
        "version": "2.0.0",
        "organization": "your-org"
    }
]

In this way, the subsequent batch download operation will only be carried out for the packages we specified.

Batch Download All Packages to the Local: ohpm-repo batch_download

Before executing the batch_download command, it is necessary to ensure that the export_pkginfo command has been successfully executed to generate the pkgInfo_xxx.json file. The batch_download command is used to batch download the package files of ohpm-repo or the OpenHarmony third-party library central repository and export them as zip files. The example is as follows:

ohpm-repo batch_download <address of pkgInfo_xxxx.json>

If you want to download from the OpenHarmony third-party library central repository, you can use the --public-registry option to specify the registry address of the central repository, and you can also use the --http-proxy option to set the proxy. This command greatly improves the efficiency of downloading multiple packages, especially suitable for scenarios where a large number of packages need to be migrated.

How to Batch Upload Packages to a New Private Repository?

How to Use batch_publish to Batch Publish the Downloaded Packages

The batch_publish command is used to batch upload the packages in the provided zip file to ohpm-repo. When executing this command, you need to specify the zip file exported by executing the batch_download command. The example is as follows:

ohpm-repo batch_publish <zip_file>

This command will automatically read the package information in the zip file and upload it to the specified private repository.

Use --force to Automatically Create an Organization and Avoid Manual Permission Adjustment

During the batch upload process, if the organization of a certain package does not exist in ohpm-repo, using the --force option can make the system select an administrator user as the organization leader to automatically create the organization. The example is as follows:

ohpm-repo batch_publish <zip_file> --force

This can avoid the cumbersome operations of manually creating an organization and adjusting permissions, improving the upload efficiency.

How to Achieve Automated Deployment? (Combined with ohpm-repo deploy for Rapid Deployment of New Instances)

The ohpm-repo deploy command can be used for the rapid deployment of new instances. The prerequisite is to have obtained the .zip file packaged by the pack command. The command format is ohpm-repo deploy <file_path> [options], where <file_path> specifies the path of the packaged product. For example:

ohpm-repo deploy D:\ohpm-repo\bin\pack_1695805599689.zip --deploy_root D:\new-ohpmrepo\ohpm-repo-deploy

Through this command, the corresponding files in the ohpm-repo deployment root directory <deploy_root> can be replaced with the specified packaged file, and the ohpm-repo service can be restarted to achieve the rapid deployment of new instances.

Optimization of Automated Operation and Maintenance: How to Improve Efficiency?

How to Integrate ohpm-repo in the CI/CD Process? (Integration Schemes for Jenkins and GitLab CI/CD)

Jenkins Integration

Integrating ohpm-repo in Jenkins can be achieved by adding the corresponding ohpm-repo commands to the scripts of Jenkins tasks. For example, add the commands for batch download and upload in the build step:

# Export package information
ohpm-repo export_pkginfo
# Batch download packages
ohpm-repo batch_download <address of pkgInfo_xxxx.json>
# Batch upload packages to the new repository
ohpm-repo batch_publish <zip_file>

GitLab CI/CD Integration

Add the corresponding script in the .gitlab-ci.yml file:

stages:
  - package-management

package-management:
  stage: package-management
  script:
    - ohpm-repo export_pkginfo
    - ohpm-repo batch_download <address of pkgInfo_xxxx.json>
    - ohpm-repo batch_publish <zip_file>

By integrating ohpm-repo in the CI/CD process, the automation of package management is achieved, and the development and deployment efficiency is improved.

How to Regularly Clean Up Old Version Packages and Optimize the Storage Space? (ohpm-repo check_storage Regularly Checks Integrity)

The ohpm-repo check_storage command can be used to check the integrity of the packages stored in sftp, and it can also be combined with scripts to achieve the function of regularly cleaning up old version packages. For example, write a shell script to regularly perform the following operations:

# Check storage integrity
ohpm-repo check_storage @all
# Logic for deleting old version packages (can be filtered according to package version information)
# For example, delete packages with a version number less than a certain value

The system's scheduled tasks (such as cron tasks) can be used to execute this script regularly, thereby optimizing the storage space.

Log Monitoring and Automatic Alarm Scheme (Combined with repoError.log for Anomaly Detection)

ohpm-repo will generate the repoError.log file, which records the error information during the operation process. Log monitoring tools (such as the ELK Stack or Prometheus + Grafana) can be used to monitor this log file. When abnormal information is detected, an automatic alarm mechanism is triggered, such as sending an email, SMS, or notifying the operation and maintenance personnel in an instant messaging tool. For example, using the ELK Stack, the repoError.log file can be collected into Elasticsearch, visually displayed through Kibana, and alarm rules can be set to trigger an alarm when specific error information appears.

Through the above automated operation and maintenance measures, we can achieve efficient management of ohpm-repo, including data migration, batch operations, automated deployment, and operation and maintenance optimization, thereby providing stable and efficient package management support for HarmonyOS Next development.