Browse Source

documentation: Update readme and puppetdoc documentation

Change-Id: I97ea6e3b4e7c4ac8b407dd3b6d39fd54ffae70fe
tags/6.0.0
Sebastien Badia 4 years ago
parent
commit
1ecba59a87
10 changed files with 250 additions and 33 deletions
  1. 65
    19
      README.md
  2. 18
    2
      manifests/agent.pp
  3. 50
    2
      manifests/api.pp
  4. 21
    1
      manifests/backend/bind9.pp
  5. 18
    2
      manifests/central.pp
  6. 5
    2
      manifests/client.pp
  7. 4
    0
      manifests/db.pp
  8. 13
    1
      manifests/dns.pp
  9. 42
    2
      manifests/init.pp
  10. 14
    2
      manifests/sink.pp

+ 65
- 19
README.md View File

@@ -1,39 +1,85 @@
1 1
 puppet-designate
2
-======
2
+================
3 3
 
4
+#### Table of Contents
5
+
6
+1. [Overview - What is the designate module?](#overview)
7
+2. [Module Description - What does the module do?](#module-description)
8
+3. [Setup - The basics of getting started with designate](#setup)
9
+4. [Implementation - An under-the-hood peek at what the module is doing](#implementation)
10
+5. [Limitations - OS compatibility, etc.](#limitations)
11
+6. [Development - Guide for contributing to the module](#development)
12
+7. [Contributors - Those with commits](#contributors)
13
+8. [Release Notes - Notes on the most recent updates to the module](#release-notes)
14
+
15
+Overview
16
+--------
17
+
18
+The designate module is a part of [Stackforge](https://github.com/stackforge), an effort by the Openstack infrastructure team to provide continuous integration testing and code review for Openstack and Openstack community projects not part of the core software. The module itself is used to flexibly configure and manage the DNS service for Openstack.
4 19
 
5 20
 Module Description
6 21
 ------------------
7 22
 
8
-The designate module aims to make Puppet capable of managing the entirely of designate.
23
+Setup
24
+-----
25
+
26
+**What the designate module affects:**
27
+
28
+* designate, the DNS service for Openstack.
29
+
30
+Implementation
31
+--------------
32
+
33
+### designate
9 34
 
35
+designate is a combination of Puppet manifest and ruby code to delivery configuration and extra functionality through types and providers.
36
+
37
+Limitations
38
+-----------
39
+
40
+Development
41
+-----------
42
+
43
+Developer documentation for the entire puppet-openstack project.
44
+
45
+* https://wiki.openstack.org/wiki/Puppet-openstack#Developer_documentation
10 46
 
11 47
 WORK IN PROGRESS
12 48
 ----------------
13 49
 
14
-✓ Basic structure  
15
-✓ DB  
16
-✓ Keystone (Users, Services, Endpoints)  
17
-✓ Client  
18
-✓ designate-api  
19
-✓ designate-central  
20
-✗ designate-agent (in progress)  
21
-✗ designate-sink  (in progress)  
22
-✓ An example of site.pp  
23
-✗ Write Tests (in progress)  
24
-
50
+✓ Basic structure
51
+✓ DB
52
+✓ Keystone (Users, Services, Endpoints)
53
+✓ Client
54
+✓ designate-api
55
+✓ designate-central
56
+✗ designate-agent (in progress)
57
+✗ designate-sink  (in progress)
58
+✓ An example of site.pp
59
+✓ Write Tests
25 60
 
26 61
 Setup
27 62
 -----
28 63
 
29 64
 ### Get Prepared for Deployment
30 65
 
31
-    Currently there is no available RPM packages for use, you need to package it from source.
66
+#### Debian/Ubuntu
67
+
68
+* Debian testing (jessie) include all designate packages.
69
+* Ubuntu utopic is the minimum requirement for Ubuntu deployment.
70
+
71
+#### RedHat
72
+
73
+* Currently there is no available RPM packages for use, you need to package it from source.
74
+ * First, clone the spec file from   https://github.com/NewpTone/designate-spec.git
75
+ * Then, clone the source file from  https://github.com/stackforge/designate.git
76
+ * Last, use rpmbuild to package it.
77
+
78
+Contributors
79
+------------
32 80
 
33
-    First, clone the spec file from   https://github.com/NewpTone/designate-spec.git
34
-    Then, clone the source file from  https://github.com/stackforge/designate.git
35
-    Last, use rpmbuild to package it.
81
+* https://github.com/stackforge/puppet-designate/graphs/contributors
36 82
 
37
-### Installing Designate
83
+Release Notes
84
+-------------
38 85
 
39
-    You could ref the example file and install it.

+ 18
- 2
manifests/agent.pp View File

@@ -1,5 +1,21 @@
1
-# Designate agent
2
-
1
+# == Class designate::agent
2
+#
3
+# Configure designate agent service
4
+#
5
+# == Parameters
6
+#
7
+# [*enabled*]
8
+#   (optional) Whether to enable services.
9
+#   Defaults to true
10
+#
11
+# [*service_ensure*]
12
+#  (optional) Whether the designate api service will be running.
13
+#  Defaults to 'running'
14
+#
15
+# [*backend_driver*]
16
+#  (optional) Driver used for backend communication (fake, rpc, bind9, powerdns)
17
+#  Defaults to 'bind9'
18
+#
3 19
 class designate::agent (
4 20
   $service_ensure = 'running',
5 21
   $backend_driver = 'bind9',

+ 50
- 2
manifests/api.pp View File

@@ -1,5 +1,53 @@
1
-# class designate::api
2
-
1
+# == Class designate::api
2
+#
3
+# Configure designate API service
4
+#
5
+# == Parameters
6
+#
7
+# [*enabled*]
8
+#   (optional) Whether to enable services.
9
+#   Defaults to true
10
+#
11
+# [*service_ensure*]
12
+#  (optional) Whether the designate api service will be running.
13
+#  Defaults to 'running'
14
+#
15
+# [*auth_strategy*]
16
+#  (optional) Authentication strategy to use, can be either "noauth" or "keystone"
17
+#  Defaults to 'noauth'
18
+#
19
+# [*keystone_host*]
20
+#  (optional) Host running auth service.
21
+#  Defaults to '127.0.0.1'
22
+#
23
+# [*keystone_port*]
24
+#  (optional) Port to use for auth service on auth_host.
25
+#  Defaults to '35357'
26
+#
27
+# [*keystone_protocol*]
28
+#  (optional) Protocol to use for auth.
29
+#  Defaults to 'http'
30
+#
31
+# [*keystone_tenant*]
32
+#  (optional) Tenant to authenticate to.
33
+#  Defaults to 'services'
34
+#
35
+# [*keystone_user*]
36
+#  (optional) User to authenticate as with keystone.
37
+#  Defaults to 'designate'
38
+#
39
+# [*keystone_password*]
40
+#  (optional) Password used to authentication.
41
+#  Defaults to false
42
+#
43
+# [*enable_api_v1*]
44
+#  (optional) Enable Designate API Version 1
45
+#  Defaults to true
46
+#
47
+# [*enable_api_v2*]
48
+#  (optional) Enable Designate API Version 2 (experimental)
49
+#  Defaults to false
50
+#
3 51
 class designate::api (
4 52
   $enabled                    = true,
5 53
   $service_ensure             = 'running',

+ 21
- 1
manifests/backend/bind9.pp View File

@@ -1,5 +1,25 @@
1
+# == Class designate::backend::bind9
2
+#
1 3
 # Configure bind9 as backend
2
-
4
+#
5
+# == Parameters
6
+#
7
+# [*rndc_config_file*]
8
+#   (optional) Location of the rndc configuration file.
9
+#   Defaults to '/etc/rndc.conf'
10
+#
11
+# [*rndc_key_file*]
12
+#  (optional) Location of the rndc key file.
13
+#  Defaults to '/etc/rndc.key'
14
+#
15
+# [*rndc_host*]
16
+#  (optional) Host running DNS service.
17
+#  Defaults to '127.0.0.1'
18
+#
19
+# [*rndc_port*]
20
+#  (optional) Port to use for dns service on rndc_host.
21
+#  Defaults to '953'
22
+#
3 23
 class designate::backend::bind9 (
4 24
   $rndc_host        = '127.0.0.1',
5 25
   $rndc_port        = '953',

+ 18
- 2
manifests/central.pp View File

@@ -1,5 +1,21 @@
1
-# designate central service
2
-
1
+# == Class designate::central
2
+#
3
+# Configure designate central service
4
+#
5
+# == Parameters
6
+#
7
+# [*enabled*]
8
+#   (optional) Whether to enable services.
9
+#   Defaults to true
10
+#
11
+# [*service_ensure*]
12
+#  (optional) Whether the designate api service will be running.
13
+#  Defaults to 'running'
14
+#
15
+# [*backend_driver*]
16
+#  (optional) Driver used for backend communication (fake, rpc, bind9, powerdns)
17
+#  Defaults to 'bind9'
18
+#
3 19
 class designate::central (
4 20
   $service_ensure = 'running',
5 21
   $enabled        = true,

+ 5
- 2
manifests/client.pp View File

@@ -1,9 +1,12 @@
1
+# == Class designate::client
1 2
 #
2 3
 # Installs the designate python library.
3 4
 #
4
-# == parameters
5
+# == Parameters
6
+#
5 7
 #  [*ensure*]
6
-#    ensure state for pachage.
8
+#    (optional) Ensure state for pachage.
9
+#    Defaults to 'present'
7 10
 #
8 11
 class designate::client (
9 12
   $ensure = 'present'

+ 4
- 0
manifests/db.pp View File

@@ -1,8 +1,12 @@
1
+# == Class designate::db
2
+#
1 3
 # Configures the designate database
4
+#
2 5
 # This class will install the required libraries depending on the driver
3 6
 # specified in the connection_string parameter
4 7
 #
5 8
 # == Parameters
9
+#
6 10
 #  [*database_connection*]
7 11
 #    the connection string. format: [driver]://[user]:[password]@[host]/[database]
8 12
 #

+ 13
- 1
manifests/dns.pp View File

@@ -1,5 +1,17 @@
1
+# == Class designate::dns
2
+#
1 3
 # Configure dns for designate service
2
-
4
+#
5
+# == Parameters
6
+#
7
+# [*designatepath*]
8
+#   (optional) Directory for maintaining designate's state
9
+#   Defailts to $designate::params::designatepath
10
+#
11
+# [*designatefile*]
12
+#   (optional) File for maintaining designate's state
13
+#   Defailts to $designate::params::designatefile
14
+#
3 15
 class designate::dns (
4 16
   $designatepath  = $::designate::params::designatepath,
5 17
   $designatefile  = $::designate::params::designatefile,

+ 42
- 2
manifests/init.pp View File

@@ -1,5 +1,45 @@
1
-# Class designate
2
-
1
+# == Class designate
2
+#
3
+# Configure designate service
4
+#
5
+# == Parameters
6
+#
7
+# [*service_ensure*]
8
+#  (optional) Whether the designate-common package will be present..
9
+#  Defaults to 'present'
10
+#
11
+# [*debug*]
12
+#   (optional) should the daemons log debug messages.
13
+#   Defaults to 'false'
14
+#
15
+# [*verbose*]
16
+#   (optional) should the daemons log verbose messages.
17
+#   Defaults to 'false'
18
+#
19
+# [*root_helper*]
20
+#   (optional) Command for designate rootwrap helper.
21
+#   Defaults to 'sudo designate-rootwrap /etc/designate/rootwrap.conf'.
22
+#
23
+# [*rabbit_host*]
24
+#   (optional) Location of rabbitmq installation.
25
+#   Defaults to '127.0.0.1'
26
+#
27
+# [*rabbit_port*]
28
+#   (optional) Port for rabbitmq instance.
29
+#   Defaults to '5672'
30
+#
31
+# [*rabbit_password*]
32
+#   (optional) Password used to connect to rabbitmq.
33
+#   Defaults to 'guest'
34
+#
35
+# [*rabbit_userid*]
36
+#   (optional) User used to connect to rabbitmq.
37
+#   Defaults to 'guest'
38
+#
39
+# [*rabbit_virtualhost*]
40
+#   (optional) The RabbitMQ virtual host.
41
+#   Defaults to '/'
42
+#
3 43
 class designate(
4 44
   $package_ensure       = present,
5 45
   $verbose              = false,

+ 14
- 2
manifests/sink.pp View File

@@ -1,5 +1,17 @@
1
-# Designate sink
2
-
1
+# == Class designate::sink
2
+#
3
+# Configure designate sink service
4
+#
5
+# == Parameters
6
+#
7
+# [*enabled*]
8
+#   (optional) Whether to enable services.
9
+#   Defaults to true
10
+#
11
+# [*service_ensure*]
12
+#  (optional) Whether the designate api service will be running.
13
+#  Defaults to 'running'
14
+#
3 15
 class designate::sink (
4 16
   $service_ensure = 'running',
5 17
   $enabled        = true,

Loading…
Cancel
Save