Remove boilerplate
Removed cruft from boilerplate and cookiecutter. Story: 2010867 Task: 48556 Change-Id: I56bc11408a4c8aa450f514c7c032e61181e18c4f Signed-off-by: Charles Short <charles.short@windriver.com>
This commit is contained in:
Charles Short
Chuck Short
parent
6487752526
commit
d99fd1608f
@ -2,11 +2,8 @@
|
||||
apt-ostree
|
||||
===============================
|
||||
|
||||
OpenStack Boilerplate contains all the boilerplate you need to create an OpenStack package.
|
||||
Hybrid image/package manager for Debian and Debian deriatives.
|
||||
|
||||
Please fill here a long description which must be at least 3 lines wrapped on
|
||||
80 cols, so that distribution package maintainers can use it in their packages.
|
||||
Note that this is a hard requirement.
|
||||
|
||||
* Free software: Apache license
|
||||
* Documentation: https://docs.openstack.org/apt-ostree/latest
|
||||
|
||||
@ -1,5 +0,0 @@
|
||||
====================
|
||||
Administrators guide
|
||||
====================
|
||||
|
||||
Administrators guide of apt-ostree.
|
||||
@ -13,14 +13,9 @@ Contents:
|
||||
:maxdepth: 2
|
||||
|
||||
readme
|
||||
install/index
|
||||
library/index
|
||||
contributor/index
|
||||
configuration/index
|
||||
cli/index
|
||||
user/index
|
||||
admin/index
|
||||
reference/index
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
@ -1,10 +0,0 @@
|
||||
2. Edit the ``/etc/apt_ostree/apt_ostree.conf`` file and complete the following
|
||||
actions:
|
||||
|
||||
* In the ``[database]`` section, configure database access:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
[database]
|
||||
...
|
||||
connection = mysql+pymysql://apt_ostree:APT_OSTREE_DBPASS@controller/apt_ostree
|
||||
@ -1,75 +0,0 @@
|
||||
Prerequisites
|
||||
-------------
|
||||
|
||||
Before you install and configure the replace with the service it implements service,
|
||||
you must create a database, service credentials, and API endpoints.
|
||||
|
||||
#. To create the database, complete these steps:
|
||||
|
||||
* Use the database access client to connect to the database
|
||||
server as the ``root`` user:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ mysql -u root -p
|
||||
|
||||
* Create the ``apt_ostree`` database:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
CREATE DATABASE apt_ostree;
|
||||
|
||||
* Grant proper access to the ``apt_ostree`` database:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
GRANT ALL PRIVILEGES ON apt_ostree.* TO 'apt_ostree'@'localhost' \
|
||||
IDENTIFIED BY 'APT_OSTREE_DBPASS';
|
||||
GRANT ALL PRIVILEGES ON apt_ostree.* TO 'apt_ostree'@'%' \
|
||||
IDENTIFIED BY 'APT_OSTREE_DBPASS';
|
||||
|
||||
Replace ``APT_OSTREE_DBPASS`` with a suitable password.
|
||||
|
||||
* Exit the database access client.
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
exit;
|
||||
|
||||
#. Source the ``admin`` credentials to gain access to
|
||||
admin-only CLI commands:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ . admin-openrc
|
||||
|
||||
#. To create the service credentials, complete these steps:
|
||||
|
||||
* Create the ``apt_ostree`` user:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack user create --domain default --password-prompt apt_ostree
|
||||
|
||||
* Add the ``admin`` role to the ``apt_ostree`` user:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack role add --project service --user apt_ostree admin
|
||||
|
||||
* Create the apt_ostree service entities:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack service create --name apt_ostree --description "replace with the service it implements" replace with the service it implements
|
||||
|
||||
#. Create the replace with the service it implements service API endpoints:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
replace with the service it implements public http://controller:XXXX/vY/%\(tenant_id\)s
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
replace with the service it implements internal http://controller:XXXX/vY/%\(tenant_id\)s
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
replace with the service it implements admin http://controller:XXXX/vY/%\(tenant_id\)s
|
||||
@ -1,9 +0,0 @@
|
||||
=======================================================
|
||||
replace with the service it implements service overview
|
||||
=======================================================
|
||||
The replace with the service it implements service provides...
|
||||
|
||||
The replace with the service it implements service consists of the following components:
|
||||
|
||||
``apt_ostree-api`` service
|
||||
Accepts and responds to end user compute API calls...
|
||||
@ -1,17 +0,0 @@
|
||||
=================================================================
|
||||
replace with the service it implements service installation guide
|
||||
=================================================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
get_started.rst
|
||||
install.rst
|
||||
verify.rst
|
||||
next-steps.rst
|
||||
|
||||
The replace with the service it implements service (apt_ostree) provides...
|
||||
|
||||
This chapter assumes a working setup of OpenStack following the
|
||||
`OpenStack Installation Tutorial
|
||||
<https://docs.openstack.org/project-install-guide/ocata/>`_.
|
||||
@ -1,34 +0,0 @@
|
||||
.. _install-obs:
|
||||
|
||||
|
||||
Install and configure for openSUSE and SUSE Linux Enterprise
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This section describes how to install and configure the replace with the service it implements service
|
||||
for openSUSE Leap 42.1 and SUSE Linux Enterprise Server 12 SP1.
|
||||
|
||||
.. include:: common_prerequisites.rst
|
||||
|
||||
Install and configure components
|
||||
--------------------------------
|
||||
|
||||
#. Install the packages:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# zypper --quiet --non-interactive install
|
||||
|
||||
.. include:: common_configure.rst
|
||||
|
||||
|
||||
Finalize installation
|
||||
---------------------
|
||||
|
||||
Start the replace with the service it implements services and configure them to start when
|
||||
the system boots:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# systemctl enable openstack-apt_ostree-api.service
|
||||
|
||||
# systemctl start openstack-apt_ostree-api.service
|
||||
@ -1,33 +0,0 @@
|
||||
.. _install-rdo:
|
||||
|
||||
Install and configure for Red Hat Enterprise Linux and CentOS
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
||||
This section describes how to install and configure the replace with the service it implements service
|
||||
for Red Hat Enterprise Linux 7 and CentOS 7.
|
||||
|
||||
.. include:: common_prerequisites.rst
|
||||
|
||||
Install and configure components
|
||||
--------------------------------
|
||||
|
||||
#. Install the packages:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# yum install
|
||||
|
||||
.. include:: common_configure.rst
|
||||
|
||||
Finalize installation
|
||||
---------------------
|
||||
|
||||
Start the replace with the service it implements services and configure them to start when
|
||||
the system boots:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# systemctl enable openstack-apt_ostree-api.service
|
||||
|
||||
# systemctl start openstack-apt_ostree-api.service
|
||||
@ -1,31 +0,0 @@
|
||||
.. _install-ubuntu:
|
||||
|
||||
Install and configure for Ubuntu
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This section describes how to install and configure the replace with the service it implements
|
||||
service for Ubuntu 14.04 (LTS).
|
||||
|
||||
.. include:: common_prerequisites.rst
|
||||
|
||||
Install and configure components
|
||||
--------------------------------
|
||||
|
||||
#. Install the packages:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# apt-get update
|
||||
|
||||
# apt-get install
|
||||
|
||||
.. include:: common_configure.rst
|
||||
|
||||
Finalize installation
|
||||
---------------------
|
||||
|
||||
Restart the replace with the service it implements services:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# service openstack-apt_ostree-api restart
|
||||
@ -1,20 +0,0 @@
|
||||
.. _install:
|
||||
|
||||
Install and configure
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This section describes how to install and configure the
|
||||
replace with the service it implements service, code-named apt_ostree, on the controller node.
|
||||
|
||||
This section assumes that you already have a working OpenStack
|
||||
environment with at least the following components installed:
|
||||
.. (add the appropriate services here and further notes)
|
||||
|
||||
Note that installation and configuration vary by distribution.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
install-obs.rst
|
||||
install-rdo.rst
|
||||
install-ubuntu.rst
|
||||
@ -1,9 +0,0 @@
|
||||
.. _next-steps:
|
||||
|
||||
Next steps
|
||||
~~~~~~~~~~
|
||||
|
||||
Your OpenStack environment now includes the apt_ostree service.
|
||||
|
||||
To add additional services, see
|
||||
https://docs.openstack.org/project-install-guide/ocata/.
|
||||
@ -1,24 +0,0 @@
|
||||
.. _verify:
|
||||
|
||||
Verify operation
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
Verify operation of the replace with the service it implements service.
|
||||
|
||||
.. note::
|
||||
|
||||
Perform these commands on the controller node.
|
||||
|
||||
#. Source the ``admin`` project credentials to gain access to
|
||||
admin-only CLI commands:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ . admin-openrc
|
||||
|
||||
#. List service components to verify successful launch and registration
|
||||
of each process:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack replace with the service it implements service list
|
||||
@ -1,7 +0,0 @@
|
||||
========
|
||||
Usage
|
||||
========
|
||||
|
||||
To use apt-ostree in a project::
|
||||
|
||||
import apt_ostree
|
||||
@ -1,5 +0,0 @@
|
||||
==========
|
||||
References
|
||||
==========
|
||||
|
||||
References of apt-ostree.
|
||||
@ -1,5 +0,0 @@
|
||||
===========
|
||||
Users guide
|
||||
===========
|
||||
|
||||
Users guide of apt-ostree.
|
||||
@ -1,11 +1,11 @@
|
||||
[metadata]
|
||||
name = apt-ostree
|
||||
summary = Hybrid image/pcakage management system
|
||||
summary = Hybrid image/package management system
|
||||
description-file =
|
||||
README.rst
|
||||
author = StarlingX Developers
|
||||
author-email = starlingx-discuss@lists.starlingx.io
|
||||
home-page = https://www.openstack.org/
|
||||
home-page = https://www.starlingx.io/
|
||||
python-requires = >=3.6
|
||||
classifier =
|
||||
Environment :: OpenStack
|
||||
|
||||
Loading…
Reference in New Issue
Block a user