A best practices checker for Kubernetes clusters. 🤠
 
 
 
 
Go to file
Varsha Varadarajan 80b6b4a8b1
Merge pull request #45 from digitalocean/varsha/context-timeout
Allow users to configure timeout while building kubernetes client
2019-07-22 17:44:05 -04:00
.circleci Add circleci config yml 2019-07-16 12:50:41 -04:00
checks Pass context while fetch k8s API objects 2019-07-18 14:24:21 -04:00
cmd/clusterlint Validate authentication mechanisms while building a new kubernetes client 2019-07-22 17:43:05 -04:00
kube Validate authentication mechanisms while building a new kubernetes client 2019-07-22 17:43:05 -04:00
script Add CI check for license headers 2019-07-02 13:58:00 -06:00
vendor Add github.com/fatih/color to vendor 2019-07-02 19:18:45 -04:00
CONTRIBUTING.md Add contributing guide and license 2019-07-02 13:30:14 -06:00
LICENSE Add contributing guide and license 2019-07-02 13:30:14 -06:00
README.md Add CircleCI badge in README 2019-07-16 13:22:08 -04:00
checks.md Add bare pod check to checks.md 2019-07-16 15:19:40 -04:00
go.mod Add github.com/fatih/color to vendor 2019-07-02 19:18:45 -04:00
go.sum Add github.com/fatih/color to vendor 2019-07-02 19:18:45 -04:00

README.md

Clusterlint

CircleCI

Linter to check k8s API objects from a live cluster.

Background

The idea for this tool was conceived to address some of the issues users face during upgrade of the cluster to a new kubernetes version. This also documents some of the recommended practices to follow while writing the object configs.

Install

go install ./cmd/clusterlint

The above command creates the clusterlint binary in $GOPATH/bin

Usage

clusterlint list [options]  // list all checks available to the user
clusterlint run [options]  // run all or specific checks

Contributing

Contributions are welcome, in the form of either issues or pull requests. Please see the contribution guidelines for details.

License

Copyright 2019 DigitalOcean

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.