Validation

Warning

Beta version

Features currently under evaluation may be modified in the next version without prior notice. If you are using these beta features, we welcome your feedback and experience. Your input is crucial to refining and improving these features before their official release. Please share your thoughts and experiences with us, and contribute to the evaluation process.

Overview

The OSP Configuration Validation tool is a new integration designed to enable users to validate their configurations without applying them. This functionality ensures that configurations are thoroughly verified prior to deployment, reducing potential errors during implementation. This tool runs within a Docker container, enabling a highly flexible and platform-independent usage.

Key features

  • Platform Flexibility: The tool is compatible with multiple operating systems, including Windows and Linux. It can also be seamlessly integrated into CI/CD workflows, such as GitLab pipelines.

  • Docker-based Deployment: Running in a Docker container provides isolation and portability, allowing easy deployment and usage across various environments.

Usage

To run the OnSphere Configuration Validation tool, use the following command:

docker run --rm -v <configuration-path>:/tmp/onsphere:ro <registry>/osp-configuration-validator:<your-configuration-version>

The table below describes the parameters used in the validation command:

Command parameters

Name

Description

Example

configuration-path

Path to the configuration on your own host

Linux: /home/myUser/configuration/myConfig or Windows: //c/Users/myUser/configuration/myConfig

registry

Docker registry containing all OnSphere images.

nexus.onsphere.ch

your-configuration-version

Version of the configuration to validate. Typically, use your current configuration version.

1.3.0

This command mounts the configuration directory from your host system into the Docker container, allowing the tool to validate your configuration files without applying them.