Getting Started

• 1: Registration Portal
• 2: Easy Install
• 3: Advanced Install

1 - Registration Portal

To make installing m9sweeper as easy as possible, we have created a registration portal that lets you sign up your company to manage m9sweeper.

It includes a wizard that walks you through installing m9sweeper end-to-end, letting you just fill in the blanks.

When you are done, it generates a helm install command for you, which could be used to install it using our helm chart with a single command.

Register | Login

2 - Easy Install

You can install m9sweeper using our helm chart. This is a one-line cli command that installs m9sweeper. Change the default username/password to your own username/password and the API Key to something random/unpredictable.

helm repo add m9sweeper https://helm.m9sweeper.io/chartrepo/m9sweeper && \
helm repo update && \
helm upgrade m9sweeper m9sweeper/m9sweeper --install --wait --create-namespace --namespace m9sweeper-system \
  --set-string dash.init.superAdminEmail="super.admin@m9sweeper.io" \
  --set-string dash.init.superAdminPassword="password" \
  --set-string global.jwtSecret="changeme" \
  --set-string global.apiKey="YOUR-API-KEY"

Many more options are available. For serious enterprise deployments, we recommend creating a helm values.yaml file and versioning this in a code repository to make upgrades easier.

For more information, see the advanced install guide.

3 - Advanced Install

Install

License

To claim a free license go to m9sweeper licensing. Claiming a license is optional, but if you setup a license our online portal will enable remote monitoring. We can notify you, for example, if you a new version is available or if your environment is no longer being monitored for some reason.

Installation

We recommend putting your configuration in a values.yaml file and then deploying our app using helm. This example uses “helm upgrade –install”, which is an idempotent way of installing and/or upgrading the app. This is repeatable and the same command can be run regardless of whether you intend to upgrade or install the app.

helm repo add m9sweeper https://helm.m9sweeper.io/chartrepo/m9sweeper && \
helm repo update && \
helm upgrade m9sweeper m9sweeper/m9sweeper --install --wait --create-namespace --namespace m9sweeper-system \
  --values values.yaml --version latest

When implementing for our customers we automate this in a CICD pipeline. Upgrades can be done simply by changing which chart version you are deploying. By default, it installs the latest version, but you can add –version to install a specific version of m9sweeper.

At a minimum, you MUST specify these 4 values:

--set-string dash.init.superAdminEmail="super.admin@m9sweeper.io"
--set-string dash.init.superAdminPassword="password"
--set-string global.jwtSecret="changeme" \
--set-string global.apiKey="YOUR-API-KEY"

Validating Webhook

If you wish to have m9sweeper prevent applications from booting up that are not compliant with your specified policies, you will need the validating webhook. This installs automatically and should work without any configuration.

However, if you are running in Azure Kubernetes Service OR have the kubernetes api firewalled in such a way that it cannot reach out to a remote url for the validating webhook, then you will need to setup an nginx reverse proxy using our reverse proxy self-installer. This script will generate a CA Certificate Bundle and Nginx configuration to enable the reverse proxy to work in Azure Kubernetes Service.

Configuration Options

If postgresql is enabled, then it will deploy postgres db. Set to false to use an external postgres DB

postgres:
  enabled: true

If rabbitmq is enabled, then it will deploy rabbitmq. Set to false to use an external rabbitmq.

rabbitmq:
  enabled: true

The following table lists the configurable parameters of the chart and the default values.