ETCD Manager

ETCD Manager

Modern, efficient and multi-platform GUI for ETCD.

ETCD Manager

Alt text

Alt text

Alt text

This is a free, cross-platform ETCD v3 client and GUI. The goal of the project is twofold:

  • Provide an efficient, modern GUI for desktop (Windows, Linux, Mac), mobile (iOS and Android) and web.
  • Cover all ETCD functionality. Anything you can do with etcdctl, you should be able to do with this tool. This should be useful for simple and power users alike.

Features

Available now

Currently, the following features are implemented:

  • Manage (create, edit, delete) keys
  • Manage users
  • Manage roles
  • Manage watchers. Supported event responders: app or desktop notification, app console logger.
  • Assign or revoke roles
  • ETCD Authentication
  • Display basic info about ETCD cluster and its nodes.

Planned

We plan to add tons of cool features in the future. The most important ones are listed below.:

Features

  • Watchers: more responders, such as Email, Log to file, Log to REST API, Slack, Whatsapp, Google Chat, Viber intergarion.
  • Cluster: maintenance features and more detailed cluster info
  • Rapid config: export / import
  • ETCD Dashboard: live dashboard with graphs.
  • Report generation in different formats (HTML, PDF, XML etc)

Future platforms

  • Android and iOS
  • Web (browser version)

A better organized overview of these plans will be available soon. Stay tuned :)

Installation

End users..

The current stable (prod) version is 1.0. It's available for Mac OS X (Mojave+), MS Windows (7, 8, 10+) and some major Linux distros (Ubuntu 10.04+, Arch etc). The following are pre-built binaries and this is the recommended way to install.

If you have Ubuntu LTS or an up-to-date rolling release distro like Arch, everything should work fine. However, please note that older Linux distros are not supported at the moment. This is something we are working on and will provcide a solution asap.

Grab one now:

Other packages are available for download as well, please see the releases page.

Contributors..

You may install the dev version by cloning this repository.

git clone https://github.com/icellmobilsoft/etcdmanager.git

Or you may also install the NPM package, although this is not recommended, since the package might not contain the latest code.

yarn add etcd-manager

Please also check out the contribution guide before writing any code.

Running the dev build

Once you have the code, simply execute the following commands.

Run this only if you've installed the package via Yarn:

cd node_modules/etcd-manager
yarn install
yarn electron:serve

Usage and support

First of all, in order to work properly, ETCD Manager must be configured.

You need to provide only two mandatory settings: the host and the port ETCD is running at. You'll find these on the settings screen, under the ETCD tab. If your ETCD host requires authentication, you will also need to provide a password / username pair, which you can do under the auth tab. There are several additional configuration options, but those are all optional.

Detailed documentation is not available (yet), but you may want to activate quick help, which is available everywhere. Press CTRL / CMD + H to open the help pane. Here you'll find some basic info as well as all the keyborad shortcuts. This should be enough to get you started.

If you still need help, please feel free to contact us. Open an issue (question / support request).

Once the documentation is ready, it'll be available in the wiki.

Upgrading

If you've installed the app using the Windows or Mac installer or the Linux AppImage, you'll be notified automatically whenever a new release is available. Simply restart the app, and it'll check for updates.

Otherwiese, you have to download and install the new version manually.

As for the dev version, you may update that by the usual means (Yarn or Git). In any case, please read our changelog for an overview of the most recent changes.

Bugs and feature requests

If you find a bug, please report it using our issue tracker.

This is also the place to request new features or ask questions. Please label your your issue appropriately, use the "bug", "enchantment" and "question" labels, respectively.

not_used
The settings screen The settings screen
Key management Key management
Watcher management Watcher management
User management section User management section

Something missing? Edit this app.

Keyboard Shortcuts

Key Action
/ Focus the search bar
Esc Focus the search bar and cleans it
Select the next search result
Select the previous search result
Enter Open the selected search result
cmdEnter Ctrl+Enter Open the selected search result in a new tab