Remove references to Tuskar
This moves Tuskar under a new "Deprecated" section in the components page and removes all other references throughout the docs. Change-Id: I1c7f2034fcce5438ffa99b33cec6fde3ef5c9199
This commit is contained in:
		
				
					committed by
					
						
						Giulio Fidente
					
				
			
			
				
	
			
			
			
						parent
						
							f1c456fcff
						
					
				
				
					commit
					5d3f1e05a7
				
			@@ -1,27 +1,23 @@
 | 
			
		||||
Deploying with Heat Templates
 | 
			
		||||
=============================
 | 
			
		||||
 | 
			
		||||
It is possible to deploy to heat directly, using a directory of templates,
 | 
			
		||||
e.g without using any Tuskar plan.  This is potentially a more convenient
 | 
			
		||||
approach if you are only deploying via the CLI (the UI requires Tuskar),
 | 
			
		||||
and/or if you are developing significant enhancements or site-specific
 | 
			
		||||
additions to the templates.
 | 
			
		||||
It is possible to use the ``--templates`` and ``--environment-file``
 | 
			
		||||
options to override specific templates or even deploy using a separate
 | 
			
		||||
set of templates entirely.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
Deploying an Overcloud without Tuskar
 | 
			
		||||
-------------------------------------
 | 
			
		||||
Deploying an Overcloud using the default templates
 | 
			
		||||
--------------------------------------------------
 | 
			
		||||
 | 
			
		||||
You may use the ``--templates`` option to enable deploying only using heat
 | 
			
		||||
templates, e.g no tuskar plan::
 | 
			
		||||
The ``--templates`` option without an argument enables deploying using
 | 
			
		||||
the packaged Heat templates::
 | 
			
		||||
 | 
			
		||||
    openstack overcloud deploy --templates
 | 
			
		||||
 | 
			
		||||
.. note::
 | 
			
		||||
 | 
			
		||||
    The default location for the templates is
 | 
			
		||||
    `/usr/share/openstack-tripleo-heat-templates`.  Using this option
 | 
			
		||||
    will not include any modifications to the Tuskar role templates which
 | 
			
		||||
    may have been performed, templates are always read from local files.
 | 
			
		||||
    `/usr/share/openstack-tripleo-heat-templates`.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
Overriding specific templates with local versions
 | 
			
		||||
 
 | 
			
		||||
@@ -93,10 +93,7 @@ infrastructure to deploy and operate OpenStack itself delivers several benefits:
 | 
			
		||||
  architecture, which has gone through extensive community review.
 | 
			
		||||
 | 
			
		||||
It should be noted that not everything in |project| is a reused OpenStack
 | 
			
		||||
element. The Tuskar API, for example (which lets users design the workload cloud
 | 
			
		||||
that they want to deploy), is found in |project| but not, so far at least, in
 | 
			
		||||
a typical Openstack instance. The Tuskar API is described in more detail below.
 | 
			
		||||
 | 
			
		||||
element.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
Deployment Workflow Overview
 | 
			
		||||
@@ -263,10 +260,7 @@ Deployment Planning
 | 
			
		||||
^^^^^^^^^^^^^^^^^^^
 | 
			
		||||
 | 
			
		||||
Whole part of planning your deployment is based on concept of **overcloud
 | 
			
		||||
roles**.
 | 
			
		||||
 | 
			
		||||
Roles are stored in the Tuskar DB, and are used through interaction with the
 | 
			
		||||
Tuskar API. A role brings together following things:
 | 
			
		||||
roles**. A role brings together following things:
 | 
			
		||||
 | 
			
		||||
* An image; the software to be installed on a node
 | 
			
		||||
* A flavor; the size of node suited to the role
 | 
			
		||||
@@ -303,16 +297,13 @@ Customizable things during deployment planning are:
 | 
			
		||||
Deployment
 | 
			
		||||
^^^^^^^^^^
 | 
			
		||||
 | 
			
		||||
Deployment to physical servers happens through a collaboration of Tuskar, Heat,
 | 
			
		||||
Nova, Neutron, Glance and Ironic.
 | 
			
		||||
Deployment to physical servers happens through a collaboration of
 | 
			
		||||
Heat, Nova, Neutron, Glance and Ironic.
 | 
			
		||||
 | 
			
		||||
To deploy the overcloud Tuskar needs gather all plan information it keeps and
 | 
			
		||||
build a Heat templates which describe desired overcloud.
 | 
			
		||||
 | 
			
		||||
This template is served to Heat which will orchestrate the whole deployment
 | 
			
		||||
and it will create a stack. Stack is Heat's own term for the applications that
 | 
			
		||||
it creates. The overcloud, in Heat terms, is a particularly complex instance of
 | 
			
		||||
a stack.
 | 
			
		||||
The Heat templates and environments are served to Heat which will
 | 
			
		||||
orchestrate the whole deployment and it will create a stack. Stack is
 | 
			
		||||
Heat's own term for the applications that it creates. The overcloud,
 | 
			
		||||
in Heat terms, is a particularly complex instance of a stack.
 | 
			
		||||
 | 
			
		||||
In order for the stack to be deployed, Heat makes successive calls to Nova,
 | 
			
		||||
OpenStack's compute service controller. Nova depends upon Ironic, which, as
 | 
			
		||||
@@ -412,7 +403,5 @@ stages:
 | 
			
		||||
 | 
			
		||||
* Making sure you have enough nodes to deploy on (or register new nodes as
 | 
			
		||||
  described in the "Undercloud Data Preparation" section above).
 | 
			
		||||
* Updating the plan managed by Tuskar, as described in the "Deployment Planning"
 | 
			
		||||
  section above.
 | 
			
		||||
* Calling Heat to update the stack which will apply the set of changes to the
 | 
			
		||||
  overcloud.
 | 
			
		||||
 
 | 
			
		||||
@@ -232,37 +232,6 @@ for details.
 | 
			
		||||
* Blueprints: https://blueprints.launchpad.net/ironic-inspector
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
Deployment Planning
 | 
			
		||||
-------------------
 | 
			
		||||
Tuskar
 | 
			
		||||
^^^^^^
 | 
			
		||||
The Tuskar project is responsible for planning of deployments through the use
 | 
			
		||||
of two main concepts: Role (unit of functionality, e.g. 'Compute') and Plan.
 | 
			
		||||
A given Role is associated with a number of Heat templates and extra
 | 
			
		||||
data files and Tuskar allows the user to provide values for a Role's template
 | 
			
		||||
attributes.
 | 
			
		||||
 | 
			
		||||
Once a Plan is specified in terms of Roles (and any desired
 | 
			
		||||
template attributes have been set) Tuskar can assemble and generate the
 | 
			
		||||
corresponding Heat deployment files and return these to the caller
 | 
			
		||||
(ready to be passed to Heat).
 | 
			
		||||
 | 
			
		||||
**How to contribute**
 | 
			
		||||
 | 
			
		||||
The Tuskar project uses the usual OpenStack code review process with gerrit
 | 
			
		||||
reviews (see links below). Tuskar is a sub-project falling under TripleO
 | 
			
		||||
and as such you can use the #tripleo irc channel (freenode) or the weekly
 | 
			
		||||
TripleO meeting to bring up issues about Tuskar, as well as the openstack-dev
 | 
			
		||||
mailing list of course.
 | 
			
		||||
 | 
			
		||||
**Useful links**
 | 
			
		||||
 | 
			
		||||
* Upstream Project: https://github.com/openstack/tuskar
 | 
			
		||||
* PyPI: https://pypi.python.org/pypi/tuskar
 | 
			
		||||
* Bugs: https://bugs.launchpad.net/tuskar
 | 
			
		||||
* Blueprints: https://blueprints.launchpad.net/tuskar
 | 
			
		||||
* REST API http://specs.openstack.org/openstack/tripleo-specs/specs/juno/tripleo-juno-tuskar-rest-api.html
 | 
			
		||||
* Reviews: https://review.openstack.org/#/q/status:open+project:openstack/tuskar,n,z
 | 
			
		||||
 | 
			
		||||
Deployment & Orchestration
 | 
			
		||||
--------------------------
 | 
			
		||||
@@ -313,8 +282,7 @@ tripleo-heat-templates
 | 
			
		||||
 | 
			
		||||
The tripleo-heat-templates describe the OpenStack deployment in Heat
 | 
			
		||||
Orchestration Template YAML files and Puppet manifests. The templates
 | 
			
		||||
are processed through Tuskar and materialized into an actual
 | 
			
		||||
deployment via Heat.
 | 
			
		||||
are deployed via Heat.
 | 
			
		||||
 | 
			
		||||
**How to contribute**
 | 
			
		||||
 | 
			
		||||
@@ -425,3 +393,18 @@ like node introspection, overcloud image building and uploading, etc.
 | 
			
		||||
    <GLOBAL_LINKS>
 | 
			
		||||
 | 
			
		||||
.. _OpenStack Developer's Guide: http://docs.openstack.org/infra/manual/developers.html
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
Deprecated
 | 
			
		||||
----------
 | 
			
		||||
Tuskar
 | 
			
		||||
^^^^^^
 | 
			
		||||
 | 
			
		||||
The Tuskar project was responsible for planning the deployments and
 | 
			
		||||
generating the corresponding Heat templates. This is no longer
 | 
			
		||||
necessary as Heat supports this composability out of the box.
 | 
			
		||||
 | 
			
		||||
The source code is available below, but please note that it should not
 | 
			
		||||
be used for new deployments.
 | 
			
		||||
 | 
			
		||||
https://github.com/openstack/tuskar
 | 
			
		||||
 
 | 
			
		||||
@@ -36,7 +36,7 @@ Now restore the MariaDB configuration file and database backup, then start the M
 | 
			
		||||
  systemctl start mariadb
 | 
			
		||||
  cat /root/undercloud-all-databases.sql | mysql
 | 
			
		||||
  # Now we need to clean out some old permissions to be recreated
 | 
			
		||||
  for i in ceilometer glance heat ironic keystone neutron nova tuskar;do mysql -e "drop user $i";done
 | 
			
		||||
  for i in ceilometer glance heat ironic keystone neutron nova;do mysql -e "drop user $i";done
 | 
			
		||||
  mysql -e 'flush privileges'
 | 
			
		||||
 | 
			
		||||
Now create the stack user and restore the stack users home directory::
 | 
			
		||||
 
 | 
			
		||||
@@ -100,6 +100,3 @@ to::
 | 
			
		||||
 | 
			
		||||
    bootstrap_nodeid: {get_attr: [Controller, resource.1.hostname]}
 | 
			
		||||
    bootstrap_nodeid_ip: {get_attr: [Controller, resource.1.ip_address]}
 | 
			
		||||
 | 
			
		||||
Tuskar doesn't support template editing so it's possible to do this change only
 | 
			
		||||
if overcloud is deployed with :doc:`templates directly <../advanced_deployment/template_deploy>`.
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user