Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include Docker instructions for etcd #6

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion docs/source/guide/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,24 @@ Installing
# start a local etcd server
/tmp/etcd-download-test/etcd

Or if you prefer to use Docker:

.. code-block:: console

export NODE1=$(hostname -I | awk '{ print $1 }')
export REGISTRY=gcr.io/etcd-development/etcd

docker run --rm \
-p 2379:2379 \
-p 2380:2380 \
--volume=${DATA_DIR}:/etcd-data \
--name etcd ${REGISTRY}:v3.4.14 \
/usr/local/bin/etcd \
--data-dir=/etcd-data --name node1 \
--initial-advertise-peer-urls http://${NODE1}:2380 --listen-peer-urls http://0.0.0.0:2380 \
--advertise-client-urls http://${NODE1}:2379 --listen-client-urls http://0.0.0.0:2379 \
--initial-cluster node1=http://${NODE1}:2380

For more advanced configuration or installation on different platforms please refer to the official documentation on the release_ page. Note that the etcd version mentioned in the script above is the latest available at the time of writing this documentation. Use any compatible version.

.. _release: https://github.com/etcd-io/etcd/releases
Expand Down Expand Up @@ -106,4 +124,4 @@ This example represents the landing event for the flight AZ203 in Fiumicino(FCO)

``payload`` is used to assign a value to the specific event notified. It is, however, optional. If not given the payload will be `None`. This last case is used when only an acknowledgement that something happened is needed.

The complete list of available commands can be found in :ref:`notification_cli`
The complete list of available commands can be found in :ref:`notification_cli`