From: Taseer Ahmed Date: Mon, 2 Jul 2018 10:35:37 +0000 (+0500) Subject: Add ansible-odl docs in its own repository. X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=commitdiff_plain;h=f00bf31fbfc73c60f2dbd1c29ea899de2b92a536;p=integration%2Fpackaging%2Fansible-opendaylight.git Add ansible-odl docs in its own repository. Ansible-Opendaylight has docs, but are hosted in a different repository. This patch places the docs in its own directory. For now the work is based on the existing material present in the Int/Pack repository. JIRA: INTPAK-190 Change-Id: I2537318e7ea721206b8b1d5c89b518c46dc1c77f Signed-off-by: Taseer Ahmed --- diff --git a/docs/_static/logo.png b/docs/_static/logo.png new file mode 100644 index 0000000..861e1af Binary files /dev/null and b/docs/_static/logo.png differ diff --git a/docs/ansible-role.rst b/docs/ansible-role.rst new file mode 100644 index 0000000..ec4db0a --- /dev/null +++ b/docs/ansible-role.rst @@ -0,0 +1,119 @@ +Ansible Role +============ +Ansible role for the `OpenDaylight SDN controller`_. + +Installing Ansible-OpenDaylight +------------------------------- +The Ansible Galaxy tool that ships with Ansible can be used to install +ansible-opendaylight. + +To install the latest version of Ansible on Red Hat-based OSs: + +:: + + $ sudo yum install -y ansible + + +To install the latest version of Ansible on Debian-based OSs: + +:: + + $ sudo apt-add-repository ppa:ansible/ansible + $ sudo apt-get update + $ sudo apt-get install -y ansible + + +After you install **ansible-galaxy**, install ansible-opendaylight: + +:: + + $ ansible-galaxy install git+ssh://@git.opendaylight.org:29418/integration/packaging/ansible-opendaylight.git + +The OpenDaylight Ansible role doesn't depend on any other Ansible roles. + +Role Variables +-------------- + +Karaf Features +^^^^^^^^^^^^^^ +To set extra Karaf features to be installed at OpenDaylight start time, pass +them in a list to the **extra_features** variable. The extra features you pass +will typically be driven by the requirements of your use case. + +OpenDaylight normally installs a default set of Karaf features at boot. They +are recommended, so the ODL Ansible role defaults to installing them. This can +be customized by overriding the **default_features** variable. You shouldn't +normally need to do so. + +REST API Port +^^^^^^^^^^^^^ +To change OpenDaylight's northbound REST API port from the default of 8181, use +the **odl_rest_port** variable. + +For example, in an Openstack deployment, the Swift project uses 8181 and +conflicts with OpenDaylight. + +The Ansible role will handle opening this port in FirewallD if it's active. + +Install Method +^^^^^^^^^^^^^^ +OpenDaylight supports RPM and deb-based installs, either from a repository +or directly from a URL to a package. Use the **instal_method** var to configure +which deployment scenario is used. + +Valid options: + rpm_repo: Install ODL using its Yum repo config + rpm_path: Install ODL RPM from a local path or remote URL + dep_repo: Install ODL using a Debian repository + deb_path: Install ODL .deb from a local path or remote URL + +Installing OpenDaylight +----------------------- +To install OpenDaylight via ansible-opendaylight, use **ansible-playbook**. + +:: + + sudo ansible-playbook -i "localhost," -c local examples/ + +Example playbooks are provided for various deployments. + +Example Playbooks +----------------- +The playbook below would install and configure OpenDaylight using all defaults. + +:: + + --- + - hosts: example_host + sudo: yes + roles: + - opendaylight + +To override default settings, pass variables to the **opendaylight** role. + +:: + + --- + - hosts: all + sudo: yes + roles: + - role: opendaylight + extra_features: ['odl-netvirt-openstack'] + +Results in: + +:: + + opendaylight-user@root>feature:list | grep odl-netvirt-openstack + odl-netvirt-openstack | | x | odl-netvirt- | OpenDaylight :: NetVirt :: OpenStack + +License +------- +OpenDaylight is Open Source. Contributions encouraged! + +Author Information +------------------ +The `OpenDaylight Integration/Packaging project`_ maintains this role. + +.. _OpenDaylight SDN controller: https://www.opendaylight.org/what-we-do/odl-platform-overview +.. _OpenDaylight Integration/Packaging project: https://wiki.opendaylight.org/view/Integration/Packaging \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..8af3658 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,25 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# SPDX-License-Identifier: EPL-1.0 +############################################################################## +# Copyright (c) 2018 The Linux Foundation and others. +# +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Eclipse Public License v1.0 +# which accompanies this distribution, and is available at +# http://www.eclipse.org/legal/epl-v10.html +############################################################################## + +from docs_conf.conf import * + +# Append to intersphinx_mapping +#intersphinx_mapping['odl-releng-builder'] = ('http://docs.opendaylight.org/projects/releng-builder/en/latest/', None) + +linkcheck_ignore = [ + # Ignore jenkins because it's often slow to respond. + 'https://jenkins.opendaylight.org/releng', + 'https://jenkins.opendaylight.org/sandbox', +] + +nitpicky = True +html_favicon = None diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 0000000..c30473c --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,6 @@ +--- +project_cfg: opendaylight +project: Ansible OpenDaylight +version: master +copyright: 2017, Daniel Farrell +author: Daniel Farrell diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..e8ade89 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,18 @@ +.. ansible-odl documentation master file, created by + sphinx-quickstart on Mon Jul 2 15:31:21 2018. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to ansible-odl's documentation! +======================================= + +Contents: + +.. noqa +.. toctree:: + :glob: + :maxdepth: 4 + :caption: Table of Contents + :name: mastertoc + + ** \ No newline at end of file