kennyopennix/openshift-linter repository overview
OpenShift Linter
This is a utility for OpenShift users/admins who want to know if certain rules have been followed.
Fig. 1 OpenShift Linter GUI
Quick usage
If you're unsure if this tool is for you, switch to a busy project using oc and enter:
$ oc export dc --raw | docker run --rm -i gerald1248/openshift-linter:latest
Usage
Usage: ./openshift-linter [<JSON/YAML file> [<JSON/YAML file>]]
-c string
TLS server certificate (default "cert.pem")
-k string
TLS server key (default "key.pem")
-n string
hostname (default "localhost")
-o string
output format (json, yaml or md) (default "md")
-p int
listen on port (default 8443)
--checks string
pattern for selected checks (default "^[a-z0-9 _-]+$")
--container string
pattern for containers (default "^[a-z0-9_-]+$")
--env string
pattern for environment variables (default "^[A-Z0-9_-]+$")
--name string
pattern for names (default "^[a-z0-9_-]+$")
--namespace string
pattern for namespaces/projects (default "^[a-z0-9_-]*$")
--skip-container string
pattern for skipped containers
--whitelist-registries string
pattern for whitelisted registries (default ".*")
Commands:
list Print list of available checks
The main use cases are:
- Command line: create report based on OpenShift configuration objects
- Server: you wish to generate reports by posting configuration files to the server at the URL shown
- GUI: point your browser to the URL shown and fetch current configuration data from the master
Command line use
As part of an automation pipeline, use:
$ oc export dc,bc,route --raw | openshift-linter
The --raw flag ensures that namespace information is present.
If the configuration objects are available as files, enter:
$ ./openshift-linter i-contain-multitudes.yaml
Both JSON and YAML can be provided.
The sample configuration data/sample-mix.min.json, for example, produces the following markdown output (excerpt):
image pull policy
-----------------
### always
|**Namespace**|**Name** |**Container** |
|:------------|:----------------------|:---------------|
|samples |ruby-hello-one-error |ruby-hello-world|
|samples |ruby-hello-two-errors |ruby-hello-world|
|samples |ruby-hello-three-errors|ruby-hello-world|
|samples |ruby-hello-four-errors |ruby-hello-world|
To write out YAML or JSON instead, use the -o switch specifying either json or yaml.
When setting naming conventions for namespaces, names, containers and environment variables, be sure to use anchors to describe the string as a whole.
Specifying checks
The option --checks allows the user to specify one or more of the available checks (see Listing below):
$ ./openshift-linter --checks limits input.yaml
Regular expressions can be used here, so the following invokes all checks related to limits/requests and security:
$ ./openshift-linter --checks "(limits|security)" input.yaml
Note that quotation marks may be necessary in this case.
Server use
$ ./openshift-linter
Listening on port 8443
POST JSON sources to https://localhost:8443/openshift-linter
Generate report at https://localhost:8443/openshift-linter/report
You can supply parameters by adding customNamespaceLabel, customNamespacePattern, customNamePattern, customContainerPattern, customEnvPattern properties to the JSON object passed to the server.
GUI use
Open the URL shown in your browser to fetch configuration data from your OpenShift master. If you've already created a report, you can sideload and create the browser view with charts that way. You can supply the parameters usually specified on the command line in the Settings pane.
Listing
To print a list of the available linter items with descriptions, enter:
$ ./openshift-linter list
|**Item** |**Description** |
|:-----------------|:----------------------------------------------------------|
|env name collision|near-identical env names |
|env name invalid |env name doesn't match predefined regex |
|health |health check missing or incomplete |
|image pull policy |policy 'Always' or ':latest' image specified |
|limits |resource limits missing, incomplete or invalid |
|name invalid |namespace, name or container doesn't match predefined regex|
|registry |registry not whitelisted |
|route conflict |route has more than one name |
|security |privileged security context |
Docker image for Openshift linter project https://github.com/gerald1248/openshift-linter Started by gerald1248
Tag summary
Content type
Image
Digest
Size
4.3 MB
Last updated
almost 8 years ago
docker pull kennyopennix/openshift-linter