kubectl atlas

A kubectl plugin to interact with MongoDB Atlas leveraging the MongoDB Atlas Operator.

Quick Start

Installation

1. Install krew
2. Execute:

kubectl krew index add atlas https://github.com/s-urbaniak/kube-atlas-cli.git
kubectl krew install atlas/atlas

Upgrade

To upgrade, consult the krew documentation and execute:

$ kubectl krew upgrade

Updated the local copy of plugin index "atlas".
  Upgrades available for installed plugins:
    * atlas/atlas v0.0.1 -> v0.0.2
Upgrading plugin: atlas/atlas
Upgraded plugin: atlas/atlas

3. Invoke the atlas kubectl plugin:

kubectl atlas --help

Developer Notes

Architecture

This plugin builds on top of the official Kubernetes Plugin framework krew, maintained by SIG-CLI.

An overview about the plugin architecture is available at https://github.com/kubernetes-sigs/krew/blob/master/docs/KREW_ARCHITECTURE.md.

Release

1. Push a tag in the form of vx.y.z:

git tag vx.y.z
git push origin --tags

2. Once the release GitHub action is done, approve and merge the krew index update. See #4 for an example PR.