Docs: true-up to recent changes
A few doc edits so that they're in sync with the OSH mission statement, helm-toolkit conventions, and project doc location. Change-Id: I33ccc39cd84fab3b537ad93970c21cf9065044e9
This commit is contained in:
Matt McEuen
parent
ed81234e22
commit
ec86066a19
16
README.rst
16
README.rst
@ -5,9 +5,9 @@ OpenStack-Helm
|
||||
Mission
|
||||
-------
|
||||
|
||||
The goal of OpenStack-Helm is to enable deployment, maintenance, and upgrading
|
||||
of loosely coupled OpenStack services and their dependencies individually or as
|
||||
part of complex environments.
|
||||
The goal of OpenStack-Helm is to provide a collection of Helm charts that
|
||||
simply, resiliently, and flexibly deploy OpenStack and related services
|
||||
on Kubernetes.
|
||||
|
||||
Communication
|
||||
-------------
|
||||
@ -31,18 +31,18 @@ Bugs and blueprints are tracked via OpenStack-Helm's Launchpad.
|
||||
Installation and Development
|
||||
----------------------------
|
||||
|
||||
Please review our documentation at `Read the Docs <http://openstack-helm.readthedocs.io/>`_.
|
||||
Please review our `documentation <https://docs.openstack.org/openstack-helm>`_.
|
||||
For quick installation, evaluation, and convenience, we have a kubeadm
|
||||
based all-in-one solution that runs in a Docker container. The Kubeadm-AIO set
|
||||
up can be found `here, <http://openstack-helm.readthedocs.io/en/latest/install/developer/all-in-one.html>`_
|
||||
and the `gate scripts, <http://openstack-helm.readthedocs.io/en/latest/install/developer/gates.html>`_
|
||||
up can be found `here, <https://docs.openstack.org/openstack-helm/latest/install/developer/all-in-one.html>`_
|
||||
and the `gate scripts, <https://docs.openstack.org/openstack-helm/latest/install/developer/gates.html>`_
|
||||
use are supported on any fresh Ubuntu, CentOS or Fedora machine.
|
||||
|
||||
This project is under active development. We encourage anyone interested in
|
||||
OpenStack-Helm to review our `Installation <http://openstack-helm.readthedocs.io/en/latest/install/index.html>`_
|
||||
OpenStack-Helm to review our `Installation <https://docs.openstack.org/openstack-helm/latest/install/index.html>`_
|
||||
documentation. Feel free to ask questions or check out our current
|
||||
`Issues and Bugs <https://bugs.launchpad.net/openstack-helm>`_.
|
||||
|
||||
To evaluate a multinode installation, follow the
|
||||
`Bare Metal <http://openstack-helm.readthedocs.io/en/latest/install/multinode.html>`_
|
||||
`Bare Metal <https://docs.openstack.org/openstack-helm/latest/install/multinode.html>`_
|
||||
install guide.
|
||||
|
||||
@ -16,7 +16,7 @@ apiVersion: v1
|
||||
description: OpenStack-Helm DNS Helper
|
||||
name: dns-helper
|
||||
version: 0.1.0
|
||||
home: http://openstack-helm.readthedocs.io
|
||||
home: https://docs.openstack.org/openstack-helm
|
||||
sources:
|
||||
- https://git.openstack.org/cgit/openstack/openstack-helm
|
||||
maintainers:
|
||||
|
||||
@ -7,7 +7,7 @@ Kubernetes itself. This requires OpenStack-Helm to develop common and
|
||||
simple scripts with minimal dependencies that can be overlaid on any
|
||||
image that meets the OpenStack core library requirements. The advantage
|
||||
of this is that the project can be image agnostic, allowing operators to
|
||||
use Stackanetes, Kolla, Yaodu, or any image flavor and format they
|
||||
use Stackanetes, Kolla, LOCI, or any image flavor and format they
|
||||
choose and they will all function the same.
|
||||
|
||||
A long-term goal, besides being image agnostic, is to also be able to
|
||||
@ -56,18 +56,19 @@ chart:
|
||||
::
|
||||
|
||||
images:
|
||||
bootstrap: docker.io/kolla/ubuntu-source-heat-engine:3.0.3
|
||||
db_init: docker.io/kolla/ubuntu-source-heat-engine:3.0.3
|
||||
db_sync: docker.io/kolla/ubuntu-source-heat-api:3.0.3
|
||||
db_drop: docker.io/kolla/ubuntu-source-heat-engine:3.0.3
|
||||
ks_user: docker.io/kolla/ubuntu-source-heat-engine:3.0.3
|
||||
ks_service: docker.io/kolla/ubuntu-source-heat-engine:3.0.3
|
||||
ks_endpoints: docker.io/kolla/ubuntu-source-heat-engine:3.0.3
|
||||
api: docker.io/kolla/ubuntu-source-heat-api:3.0.3
|
||||
cfn: docker.io/kolla/ubuntu-source-heat-api:3.0.3
|
||||
cloudwatch: docker.io/kolla/ubuntu-source-heat-api:3.0.3
|
||||
engine: docker.io/kolla/ubuntu-source-heat-engine:3.0.3
|
||||
dep_check: quay.io/stackanetes/kubernetes-entrypoint:v0.2.1
|
||||
tags:
|
||||
bootstrap: docker.io/kolla/ubuntu-source-heat-engine:3.0.3
|
||||
db_init: docker.io/kolla/ubuntu-source-heat-engine:3.0.3
|
||||
db_sync: docker.io/kolla/ubuntu-source-heat-api:3.0.3
|
||||
db_drop: docker.io/kolla/ubuntu-source-heat-engine:3.0.3
|
||||
ks_user: docker.io/kolla/ubuntu-source-heat-engine:3.0.3
|
||||
ks_service: docker.io/kolla/ubuntu-source-heat-engine:3.0.3
|
||||
ks_endpoints: docker.io/kolla/ubuntu-source-heat-engine:3.0.3
|
||||
api: docker.io/kolla/ubuntu-source-heat-api:3.0.3
|
||||
cfn: docker.io/kolla/ubuntu-source-heat-api:3.0.3
|
||||
cloudwatch: docker.io/kolla/ubuntu-source-heat-api:3.0.3
|
||||
engine: docker.io/kolla/ubuntu-source-heat-engine:3.0.3
|
||||
dep_check: quay.io/stackanetes/kubernetes-entrypoint:v0.2.1
|
||||
pull_policy: "IfNotPresent"
|
||||
|
||||
The OpenStack-Helm project today uses a mix of Docker images from
|
||||
|
||||
@ -39,8 +39,8 @@ This is accomplished with the following annotation:
|
||||
|
||||
...
|
||||
annotations:
|
||||
configmap-bin-hash: {{ tuple "configmap-bin.yaml" . | include "hash" }}
|
||||
configmap-etc-hash: {{ tuple "configmap-etc.yaml" . | include "hash" }}
|
||||
configmap-bin-hash: {{ tuple "configmap-bin.yaml" . | include "helm-toolkit.utils.hash" }}
|
||||
configmap-etc-hash: {{ tuple "configmap-etc.yaml" . | include "helm-toolkit.utils.hash" }}
|
||||
|
||||
The ``hash`` function defined in the ``helm-toolkit`` chart ensures that
|
||||
any change to any file referenced by configmap-bin.yaml or
|
||||
|
||||
@ -77,7 +77,7 @@ The default FQDN's for OpenStack-Helm are
|
||||
We want to change the ***public*** configurations to match our DNS layouts above. In each Chart
|
||||
``values.yaml`` is a ``endpoints`` configuration that has ``host_fqdn_override``'s for each API
|
||||
that the Chart either produces or is dependant on. `Read more about how Endpoints are developed
|
||||
<http://openstack-helm.readthedocs.io/en/latest/devref/endpoints.html>`__.
|
||||
<https://docs.openstack.org/openstack-helm/latest/devref/endpoints.html>`__.
|
||||
Note while Glance Registry is listening on a Ingress http endpoint, you will not need to expose
|
||||
the registry for external services.
|
||||
|
||||
@ -153,7 +153,7 @@ Examples
|
||||
Code examples below.
|
||||
|
||||
If doing an `AIO install
|
||||
<http://openstack-helm.readthedocs.io/en/latest/install/developer/all-in-one.html>`__,
|
||||
<https://docs.openstack.org/openstack-helm/latest/install/developer/all-in-one.html>`__,
|
||||
all the ``--set`` flags
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
Loading…
Reference in New Issue
Block a user