summaryrefslogtreecommitdiffstats
path: root/docs/configurationguide
diff options
context:
space:
mode:
authorjoehuang <joehuang@huawei.com>2016-09-20 05:20:31 -0400
committerjoehuang <joehuang@huawei.com>2016-09-20 05:27:44 -0400
commit3f7394289faa2945e8f36d008cfb7dacf06279d6 (patch)
treede4c58563b7db1ebb33122ae1b4367b640e801eb /docs/configurationguide
parentb50a7a8c4d2f4a1e63b7dce077f9d3f726661a15 (diff)
Cherry Pick the update from the master branch to stable/colorado branch
These patches should be cherry picked to colorado branch: https://gerrit.opnfv.org/gerrit/#/c/20077/ https://gerrit.opnfv.org/gerrit/#/c/20635/ https://gerrit.opnfv.org/gerrit/#/c/19833/ https://gerrit.opnfv.org/gerrit/#/c/19587/ But because the structure of the folder was changed in https://gerrit.opnfv.org/gerrit/#/c/19833/ cherry pick using gerrit will lead to merge conflict, has to update the colorado branch through this patch. Change-Id: I971eb28520b47b14de52a761269518b959c6921c Signed-off-by: joehuang <joehuang@huawei.com>
Diffstat (limited to 'docs/configurationguide')
-rw-r--r--docs/configurationguide/configuration.options.render.rst27
-rw-r--r--docs/configurationguide/index.rst12
-rw-r--r--docs/configurationguide/multisite-configuration-guide.rst110
-rw-r--r--docs/configurationguide/multisite.kingbird.configuration.description.rst265
4 files changed, 0 insertions, 414 deletions
diff --git a/docs/configurationguide/configuration.options.render.rst b/docs/configurationguide/configuration.options.render.rst
deleted file mode 100644
index f1dc11a..0000000
--- a/docs/configurationguide/configuration.options.render.rst
+++ /dev/null
@@ -1,27 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) Christopher Price (Ericsson AB)
-
-=====================
-Configuration Options
-=====================
-
-OPNFV provides a variety of virtual infrastructure deployments called scenarios designed to
-host Virtualised Network Functions(VNFs). Each scenario provide specific capabilities and/or
-components aimed to solve specific problems for the deployment of VNF's. A scenario may include
-components such as OpenStack, OpenDaylight, OVS, KVM etc. where each scenario will include
-different source components or configurations.
-
-OPNFV Scenarios
-===============
-
-Each OPNFV scenario provides unique features and capabilities, it is important to understand
-your target platform capabilities before installing and configuring your target scenario.
-This configuration guide outlines how to install and configure components in order to enable
-the features you require.
-
-.. include:: ../scenario/scenariomatrix.rst
-
-This document will describe how to install and configure your target OPNFV scenarios.
-Remember to check the associated validation procedures section following your installation for
-details of the use cases and tests that have been run.
diff --git a/docs/configurationguide/index.rst b/docs/configurationguide/index.rst
deleted file mode 100644
index 791d94d..0000000
--- a/docs/configurationguide/index.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-*****************************
-Multisite Configuration Guide
-*****************************
-
-.. toctree::
- :numbered:
- :maxdepth: 2
-
- multisite.kingbird.configuration.description.rst
diff --git a/docs/configurationguide/multisite-configuration-guide.rst b/docs/configurationguide/multisite-configuration-guide.rst
deleted file mode 100644
index c005e8d..0000000
--- a/docs/configurationguide/multisite-configuration-guide.rst
+++ /dev/null
@@ -1,110 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-=============================
-Multisite configuration guide
-=============================
-
-Multisite identity service management
-=====================================
-
-Goal
-----
-
-A user should, using a single authentication point be able to manage virtual
-resources spread over multiple OpenStack regions.
-
-Before you read
----------------
-
-This chapter does not intend to cover all configuration of KeyStone and other
-OpenStack services to work together with KeyStone.
-
-This chapter focuses only on the configuration part should be taken into
-account in multi-site scenario.
-
-Please read the configuration documentation related to identity management
-of OpenStack for all configuration items.
-
-http://docs.openstack.org/liberty/config-reference/content/ch_configuring-openstack-identity.html
-
-How to configure the database cluster for synchronization or asynchrounous
-repliation in multi-site scenario is out of scope of this document. The only
-remainder is that for the synchronization or replication, only Keystone
-database is required. If you are using MySQL, you can configure like this:
-
-In the master:
-
- .. code-block:: bash
-
- binlog-do-db=keystone
-
-In the slave:
-
- .. code-block:: bash
-
- replicate-do-db=keystone
-
-
-Deployment options
-------------------
-
-For each detail description of each deployment option, please refer to the
-admin-user-guide.
-
-- Distributed KeyStone service with PKI token
-
- In KeyStone configuration file, PKI token format should be configured
-
- .. code-block:: bash
-
- provider = pki
-
- or
-
- .. code-block:: bash
-
- provider = pkiz
-
- In the [keystone_authtoken] section of each OpenStack service configuration
- file in each site, configure the identity_url and auth_uri to the address
- of KeyStone service
-
- .. code-block:: bash
-
- identity_uri = https://keystone.your.com:35357/
- auth_uri = http://keystone.your.com:5000/v2.0
-
- It's better to use domain name for the KeyStone service, but not to use IP
- address directly, especially if you deployed KeyStone service in at least
- two sites for site level high availability.
-
-- Distributed KeyStone service with Fernet token
-- Distributed KeyStone service with Fernet token + Async replication (
- star-mode).
-
- In these two deployment options, the token validation is planned to be done
- in local site.
-
- In KeyStone configuration file, Fernet token format should be configured
-
- .. code-block:: bash
-
- provider = fernet
-
- In the [keystone_authtoken] section of each OpenStack service configuration
- file in each site, configure the identity_url and auth_uri to the address
- of local KeyStone service
-
- .. code-block:: bash
-
- identity_uri = https://local-keystone.your.com:35357/
- auth_uri = http://local-keystone.your.com:5000/v2.0
-
- and especially, configure the region_name to your local region name, for
- example, if you are configuring services in RegionOne, and there is local
- KeyStone service in RegionOne, then
-
- .. code-block:: bash
-
- region_name = RegionOne
diff --git a/docs/configurationguide/multisite.kingbird.configuration.description.rst b/docs/configurationguide/multisite.kingbird.configuration.description.rst
deleted file mode 100644
index d003019..0000000
--- a/docs/configurationguide/multisite.kingbird.configuration.description.rst
+++ /dev/null
@@ -1,265 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) OPNFV
-
-
-Configuration of Multisite.Kingbird
-===================================
-
-A brief introduction to configure Multisite Kingbird service. Only the
-configuration items for Kingbird will be described here. Logging,
-messaging, database, keystonemiddleware etc configuration which are
-generated from OpenStack OSLO libary, will not be described here, for
-these configuration items are common to Nova, Cinder, Neutron. So please
-refer to corresponding description from Nova or Cinder or Neutron.
-
-
-Configuration in [DEFAULT]
---------------------------
-
-configuration items for kingbird-api
-""""""""""""""""""""""""""""""""""""
-
-bind_host
-*********
-- default value: *bind_host = 0.0.0.0*
-- description: The host IP to bind for kingbird-api service
-
-bind_port
-*********
-- default value: *bind_port = 8118*
-- description: The port to bind for kingbird-api service
-
-api_workers
-***********
-- default value: *api_workers = 2*
-- description: Number of kingbird-api workers
-
-configuration items for kingbird-engine
-"""""""""""""""""""""""""""""""""""""""
-
-host
-****
-- default value: *host = localhost*
-- description: The host name kingbird-engine service is running on
-
-workers
-*******
-- default value: *workers = 1*
-- description: Number of kingbird-engine workers
-
-report_interval
-***************
-- default value: *report_interval = 60*
-- description: Seconds between running periodic reporting tasks to
- keep the engine alive in the DB. If the engine doesn't report its
- aliveness to the DB more than two intervals, then the lock accquired
- by the engine will be removed by other engines.
-
-common configuration items for kingbird-api and kingbird-engine
-"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
-
-use_default_quota_class
-***********************
-- default value: *use_default_quota_class = true*
-- description: Enables or disables use of default quota class with default
- quota, boolean value
-
-Configuration in [kingbird_global_limit]
-----------------------------------------
-
-For quota limit, a negative value means unlimited.
-
-configuration items for kingbird-api and kingbird-engine
-""""""""""""""""""""""""""""""""""""""""""""""""""""""""
-
-quota_instances
-***************
-- default value: *quota_instances = 10*
-- description: Number of instances allowed per project, integer value.
-
-quota_cores
-***********
-- default value: *quota_cores = 20*
-- description: Number of instance cores allowed per project, integer value.
-
-quota_ram
-*********
-- default value: *quota_ram = 512*
-- description: Megabytes of instance RAM allowed per project, integer value.
-
-quota_metadata_items
-********************
-- default value: *quota_metadata_items = 128*
-- description: Number of metadata items allowed per instance, integer value.
-
-quota_key_pairs
-***************
-- default value: *quota_key_pairs = 10*
-- description: Number of key pairs per user, integer value.
-
-quota_fixed_ips
-***************
-- default value: *quota_fixed_ips = -1*
-- description: Number of fixed IPs allowed per project, this should be at
- least the number of instances allowed, integer value.
-
-quota_security_groups
-*********************
-- default value: *quota_security_groups = 10*
-- description: Number of security groups per project, integer value.
-
-quota_floating_ips
-******************
-- default value: *quota_floating_ips = 10*
-- description: Number of floating IPs allowed per project, integer value.
-
-quota_network
-***************
-- default value: *quota_network = 10*
-- description: Number of networks allowed per project, integer value.
-
-quota_subnet
-***************
-- default value: *quota_subnet = 10*
-- description: Number of subnets allowed per project, integer value.
-
-quota_port
-***************
-- default value: *quota_port = 50*
-- description: Number of ports allowed per project, integer value.
-
-quota_security_group
-********************
-- default value: *quota_security_group = 10*
-- description: Number of security groups allowed per project, integer value.
-
-quota_security_group_rule
-*************************
-- default value: *quota_security_group_rule = 100*
-- description: Number of security group rules allowed per project, integer
- value.
-
-quota_router
-************
-- default value: *quota_router = 10*
-- description: Number of routers allowed per project, integer value.
-
-quota_floatingip
-****************
-- default value: *quota_floatingip = 50*
-- description: Number of floating IPs allowed per project, integer value.
-
-quota_volumes
-***************
-- default value: *quota_volumes = 10*
-- description: Number of volumes allowed per project, integer value.
-
-quota_snapshots
-***************
-- default value: *quota_snapshots = 10*
-- description: Number of snapshots allowed per project, integer value.
-
-quota_gigabytes
-***************
-- default value: *quota_gigabytes = 1000*
-- description: Total amount of storage, in gigabytes, allowed for volumes
- and snapshots per project, integer value.
-
-quota_backups
-*************
-- default value: *quota_backups = 10*
-- description: Number of volume backups allowed per project, integer value.
-
-quota_backup_gigabytes
-**********************
-- default value: *quota_backup_gigabytes = 1000*
-- description: Total amount of storage, in gigabytes, allowed for volume
- backups per project, integer value.
-
-Configuration in [cache]
-----------------------------------------
-
-The [cache] section is used by kingbird engine to access the quota
-information for Nova, Cinder, Neutron in each region in order to reduce
-the KeyStone load while retrieving the endpoint information each time.
-
-configuration items for kingbird-engine
-"""""""""""""""""""""""""""""""""""""""
-
-auth_uri
-***************
-- default value:
-- description: Keystone authorization url, for example, http://127.0.0.1:5000/v3.
-
-admin_username
-**************
-- default value:
-- description: Username of admin account, for example, admin.
-
-admin_password
-**************
-- default value:
-- description: Password for admin account, for example, password.
-
-admin_tenant
-************
-- default value:
-- description: Tenant name of admin account, for example, admin.
-
-admin_user_domain_name
-**********************
-- default value: *admin_user_domain_name = Default*
-- description: User domain name of admin account.
-
-admin_project_domain_name
-*************************
-- default value: *admin_project_domain_name = Default*
-- description: Project domain name of admin account.
-
-Configuration in [scheduler]
-----------------------------------------
-
-The [scheduler] section is used by kingbird engine to periodically synchronize
-and rebalance the quota for each project.
-
-configuration items for kingbird-engine
-"""""""""""""""""""""""""""""""""""""""
-
-periodic_enable
-***************
-- default value: *periodic_enable = True*
-- description: Boolean value for enable/disable periodic tasks.
-
-periodic_interval
-*****************
-- default value: *periodic_interval = 900*
-- description: Periodic time interval for automatic quota sync job, unit is
- seconds.
-
-Configuration in [batch]
-----------------------------------------
-
-The [batch] section is used by kingbird engine to periodicly synchronize
-and rebalance the quota for each project.
-
-batch_size
-***************
-- default value: *batch_size = 3*
-- description: Batch size number of projects will be synced at a time.
-
-Configuration in [locks]
-----------------------------------------
-
-The [locks] section is used by kingbird engine to periodically synchronize
-and rebalance the quota for each project.
-
-lock_retry_times
-****************
-- default value: *lock_retry_times = 3*
-- description: Number of times trying to grab a lock.
-
-lock_retry_interval
-*******************
-- default value: *lock_retry_interval =10*
-- description: Number of seconds between lock retries.