Skip to content

Latest commit

 

History

History
92 lines (65 loc) · 2.9 KB

TODO.md

File metadata and controls

92 lines (65 loc) · 2.9 KB
Raw

ROADMAP

The following are planned improvements to the workshop:

  1. Add instructions for changing your password.

    $ sensuctl user change-password --interactive

  2. Include StatsD examples... with tags!

    $ echo 'my_app_requests:3|g|#region:us-west-1,foo:bar' | nc -w1 -u 127.0.0.1 8125

  3. Add instructions for backing up workshop data and migrating to a local environment.

    Create a backup folder.

    $ mkdir backup

    Backup pipeline resources only (stripping namespaces for portability/reuse)...

    $ sensuctl dump assets,checks,hooks,filters,mutators,handlers,silenced,secrets/v1.Secret \
  --format yaml | grep -v "^\s*namespace:" > backup/pipelines.yaml

    Make a namespaced backup of the entire cluster (sans entities, events, apikeys)...

    $ sensuctl dump all \
  --omit entities,events,apikeys \
  --format yaml > backup/config.yaml

    Backup RBAC resources only...

    $ sensuctl dump apikeys,users,roles,rolebindings,clusterroles,clusterrolebindings
  --format yaml > backup/system-rbac.yaml

    Optionally backup entity resources?

    $ sensuctl dump entities \
  --format yaml | grep -v "^\s*namespace:" > backup/inventory.yaml

    Restore everything, or a subset of things:

    $ sensuctl create -r -f backup/
$ sensuctl create -f backup/pipelines.yaml

  4. Investigate the Docker Compose DOCKER_CONVERT_WINDOWS_PATHS environment variable to see if this helps improve "cross-platform" support for the workshop.

  5. Add alternate docker-compose templates:

    • Sensu cluster w/ standalone/external etcd
    • Self-signed certificates (documentation and scripts)

  6. Add a lesson on backup & restore.

    • Document recommended sensuctl dump command(s) for backing up pipeline resources (i.e. assets, checks, filters, mutators, handlers, etc)
    • Include instructions for creating a "production" namespace and restoring pipeline resources in the new namespace

  7. Investigate volumes.:volume.external to create a seamless transition from the landing page "quick start" to the workshop.

  8. Deprecate the Vagrant-based Sensu Go Sandbox in favor of the Sensu Go Workshop. Or turn it into a wrapper for the workshop environment for users who can't install Docker on their workstations, but can run a VM? could we refactor the workshop to basically just install Docker+Compose, clone the workshop, run it (docker-compose up -d) and make sure all the necessary ports are configured for external access (i.e. load the dashboard from
    the host machine at http://localhost:3000)?