README
¶
mch-compliance
This repo tests whether components installed by the multiclusterhub comply with standards defined in the chart onboarding documentation.
Running
Run go install to build a CLI named mch-compliance. Alternatively run go run main.go. The CLI contains a single audit commmand to be run against an installed hub cluster.
Usage:
mch-compliance audit [flags]
Examples:
# Define a list of checks to exclude from report
mch-compliance audit -c exemptions.yaml
# Generate report in a parseable json format
mch-compliance audit -o json
Flags:
-c, --config string Configuration file with exemptions
-f, --file string Filepath to save results
-h, --help help for audit
-n, --namespace string Namespace where the hub is installed (default "open-cluster-management")
-o, --output string Results format to output (default "table")
The examples folder contains an example config for excluding deployments installed via bundle, and results generated in text and yaml format by calling
mch-compliance audit -c examples/exemptions.yaml -f examples/output.yaml -o yaml
mch-compliance audit -c examples/exemptions.yaml -f examples/output.txt -o text
Documentation
¶
Overview ¶
Copyright © 2021 NAME HERE <EMAIL ADDRESS>
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Source Files
Directories