From 9b8ab565fa8f403e9cd137f9f976ca475bdc593b Mon Sep 17 00:00:00 2001 From: Eric Larson Date: Thu, 19 Feb 2015 12:01:41 -0600 Subject: [PATCH] Assume a new developer won't create a "designate" user in the dev guide The getting started docs suggest checking the code out into `/var/lib`, but this requires a later step of adding a `designate` user to the sudoers list without adding a step of adding the `designate` user in the first place. This updates the docs and basic config example to simply check out the code into `$HOME/openstack/designate/` and removes sudoers step. Closes-Bug: 1423628 Change-Id: Ia30b5460532589417a7e8b1fad9c233ced954106 --- doc/source/examples/basic-config-sample.conf | 7 ++--- doc/source/install/ubuntu-dev.rst | 32 +++++++++++--------- 2 files changed, 21 insertions(+), 18 deletions(-) diff --git a/doc/source/examples/basic-config-sample.conf b/doc/source/examples/basic-config-sample.conf index 97bfb747e..bc65a1874 100644 --- a/doc/source/examples/basic-config-sample.conf +++ b/doc/source/examples/basic-config-sample.conf @@ -8,11 +8,11 @@ verbose = True # Show debugging output in logs (sets DEBUG log level output) debug = True -# Top-level directory for maintaining designate's state -state_path = /var/lib/designate +# Top-level directory for maintaining designate's state. +state_path = $pybasedir/state # Log directory -logdir = /var/log/designate +logdir = $pybasedir/log # Driver used for issuing notifications notification_driver = messaging @@ -145,4 +145,3 @@ server_ids = 6a5032b6-2d96-43ee-b25b-7d784e2bf3b2 [backend:bind9:6a5032b6-2d96-43ee-b25b-7d784e2bf3b2] #host = 127.0.0.1 #port = 53 - diff --git a/doc/source/install/ubuntu-dev.rst b/doc/source/install/ubuntu-dev.rst index 4db59cebc..0af97d8c6 100644 --- a/doc/source/install/ubuntu-dev.rst +++ b/doc/source/install/ubuntu-dev.rst @@ -55,12 +55,13 @@ Installing Designate :: - $ cd /var/lib + $ mkdir openstack + $ cd openstack $ git clone https://github.com/openstack/designate.git $ cd designate -3. Setup virtualenv +3. Setup a virtualenv .. note:: This is an optional step, but will allow Designate's dependencies @@ -102,7 +103,15 @@ Installing Designate :: - $ mkdir /var/log/designate + $ mkdir -p ../../log + + +8. Make the directory for Designate’s state files + +:: + + $ mkdir -p ../../state + Configuring Designate @@ -236,20 +245,16 @@ Initialize & Start the Central Service double: install; central -If you intend to run Designate as a non-root user, then sudo permissions need to be granted +Sync the Designate database. :: - $ echo "designate ALL=(ALL) NOPASSWD:ALL" | sudo tee -a /etc/sudoers.d/90-designate - $ sudo chmod 0440 /etc/sudoers.d/90-designate - - -:: - - # Sync the Designate database: $ designate-manage database sync - # Start the central service: +Start the central service. + +:: + $ designate-central @@ -265,7 +270,7 @@ Open up a new ssh window and log in to your server (or however you’re communic :: - $ cd /var/lib/designate + $ cd openstack/designate # Make sure your virtualenv is sourced $ source .venv/bin/activate @@ -334,4 +339,3 @@ You can find the IP Address of your server by running A couple of notes on the API: - Before Domains are created, you must create a server (/v1/servers). -