Merge "Docs: modernise links"

HACKING.rst

@@ -2,7 +2,7 @@ Heat style commandments
 =======================
 
 - Step 1: Read the OpenStack style commandments
-  http://docs.openstack.org/developer/hacking/
+  https://docs.openstack.org/hacking/
 - Step 2: Read on
 
 Heat specific commandments

README.rst

@@ -2,8 +2,8 @@
 Team and repository tags
 ========================
 
-.. image:: http://governance.openstack.org/badges/heat.svg
+.. image:: https://governance.openstack.org/tc/badges/heat.svg
-    :target: http://governance.openstack.org/reference/tags/index.html
+    :target: https://governance.openstack.org/tc/reference/tags/index.html
 
 .. Change things from this point on
 
@@ -25,31 +25,32 @@ If you'd like to run from the master branch, you can clone the git repo:
     git clone https://git.openstack.org/openstack/heat
 
 
-* Wiki: http://wiki.openstack.org/Heat
+* Documentation: https://docs.openstack.org/heat/latest
-* Developer docs: http://docs.openstack.org/heat/latest
 * Template samples: https://git.openstack.org/cgit/openstack/heat-templates
 * Agents: https://git.openstack.org/cgit/openstack/heat-agents
 
 Python client
 -------------
-https://git.openstack.org/cgit/openstack/python-heatclient
+
+* Documentation: https://docs.openstack.org/python-heatclient/latest
+* Source: https://git.openstack.org/cgit/openstack/python-heatclient
 
 References
 ----------
-* http://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_CreateStack.html
+* https://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_CreateStack.html
-* http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide/create-stack.html
+* https://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide/create-stack.html
-* http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
+* https://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
-* http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=tosca
+* https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=tosca
 
 We have integration with
 ------------------------
 * https://git.openstack.org/cgit/openstack/python-novaclient (instance)
 * https://git.openstack.org/cgit/openstack/python-keystoneclient (auth)
-* https://git.openstack.org/cgit/openstack/python-swiftclient (s3)
+* https://git.openstack.org/cgit/openstack/python-swiftclient (object storage)
 * https://git.openstack.org/cgit/openstack/python-neutronclient (networking)
 * https://git.openstack.org/cgit/openstack/python-ceilometerclient (metering)
 * https://git.openstack.org/cgit/openstack/python-aodhclient (alarming service)
-* https://git.openstack.org/cgit/openstack/python-cinderclient (storage service)
+* https://git.openstack.org/cgit/openstack/python-cinderclient (block storage)
 * https://git.openstack.org/cgit/openstack/python-glanceclient (image service)
 * https://git.openstack.org/cgit/openstack/python-troveclient (database as a Service)
 * https://git.openstack.org/cgit/openstack/python-saharaclient (hadoop cluster)
@@ -60,3 +61,4 @@ We have integration with
 * https://git.openstack.org/cgit/openstack/python-mistralclient (workflow service)
 * https://git.openstack.org/cgit/openstack/python-zaqarclient (messaging service)
 * https://git.openstack.org/cgit/openstack/python-monascaclient (monitoring service)
+* https://git.openstack.org/cgit/openstack/python-zunclient (container management service)

contrib/heat_docker/setup.cfg

@@ -5,7 +5,7 @@ description-file =
     README.md
 author = OpenStack
 author-email = openstack-dev@lists.openstack.org
-home-page = http://docs.openstack.org/developer/heat/
+home-page = https://docs.openstack.org/heat/latest/
 classifier =
     Environment :: OpenStack
     Intended Audience :: Information Technology

doc/source/contributing/blueprints.rst

@@ -2,13 +2,13 @@ Blueprints and Specs
 ====================
 
 The Heat team uses the `heat-specs
-<http://git.openstack.org/cgit/openstack/heat-specs>`_ repository for its
+<https://git.openstack.org/cgit/openstack/heat-specs>`_ repository for its
 specification reviews. Detailed information can be found `here
 <https://wiki.openstack.org/wiki/Blueprints#Heat>`_.
 
 Please note that we use a template for spec submissions. Please use the
 `template for the latest release
-<http://git.openstack.org/cgit/openstack/heat-specs/tree/specs/templates>`_.
+<https://git.openstack.org/cgit/openstack/heat-specs/tree/specs/templates>`_.
 It is not required to fill out all sections in the template.
 
 Spec Notes

doc/source/developing_guides/architecture.rst

@@ -92,5 +92,5 @@ templates and provide events back to the API consumer.
 The templates integrate well with Puppet_ and Chef_.
 
 .. _Puppet: https://s3.amazonaws.com/cloudformation-examples/IntegratingAWSCloudFormationWithPuppet.pdf
-.. _Chef: http://www.full360.com/2011/02/27/integrating-aws-cloudformation-and-chef.html
+.. _Chef: https://www.full360.com/2011/02/27/integrating-aws-cloudformation-and-chef.html
-.. _`AWS CloudFormation`: http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/Welcome.html?r=7078
+.. _`AWS CloudFormation`: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/Welcome.html?r=7078

doc/source/developing_guides/gmr.rst

@@ -90,5 +90,4 @@ Extending the GMR
 
 As mentioned above, additional sections can be added to the GMR for a
 particular executable. For more information, see the documentation about
-``oslo.reports``:
+`oslo.reports <https://docs.openstack.org/oslo.reports/>`_
-`oslo.reports <http://docs.openstack.org/developer/oslo.reports/>`_

doc/source/getting_started/on_devstack.rst

@@ -50,7 +50,7 @@ It would also be useful to automatically download and register
 a VM image that heat can launch. To do that add the following to
 `[[local|localrc]]` section of `local.conf`::
 
-    IMAGE_URL_SITE="http://download.fedoraproject.org"
+    IMAGE_URL_SITE="https://download.fedoraproject.org"
     IMAGE_URL_PATH="/pub/fedora/linux/releases/25/CloudImages/x86_64/images/"
     IMAGE_URL_FILE="Fedora-Cloud-Base-25-1.3.x86_64.qcow2"
     IMAGE_URLS+=","$IMAGE_URL_SITE$IMAGE_URL_PATH$IMAGE_URL_FILE

doc/source/getting_started/on_fedora.rst

@@ -14,10 +14,10 @@
 Installing OpenStack and Heat on RHEL/Fedora/CentOS
 ---------------------------------------------------
 
-Go to the `OpenStack Documentation <http://docs.openstack.org/>`_ for
+Go to the `OpenStack Documentation
-the latest version of the Installation Guide for Red Hat Enterprise
+<https://docs.openstack.org/#install-guides>`_ for the latest version of the
-Linux, CentOS and Fedora which includes a chapter on installing the
+Installation Guide for Red Hat Enterprise Linux, CentOS and Fedora which
-Orchestration module (Heat).
+includes a chapter on installing the Orchestration module (Heat).
 
 There are instructions for `installing the RDO OpenStack
 <https://www.rdoproject.org/install/tripleo/>`_ on Fedora and CentOS.

doc/source/getting_started/on_ubuntu.rst

@@ -16,8 +16,9 @@ Installing Heat on Ubuntu
 
 Heat is packaged for Debian, and Ubuntu (from 13.10)
 
-Go to the `OpenStack Documentation <http://docs.openstack.org/>`_ for
+Go to the `OpenStack Documentation
-the latest version of the Installation Guide for Ubuntu which includes a
+<https://docs.openstack.org/#install-guides>`_ for the latest version of the
-chapter on installing the Orchestration module (Heat).
+Installation Guide for Ubuntu which includes a chapter on installing the
+Orchestration module (Heat).
 
 There is a `Juju Charm for Heat <https://jujucharms.com/heat/>` available.

doc/source/glossary.rst

@@ -99,10 +99,7 @@
    Provider resource
      A :term:`resource` implemented by a :term:`provider
      template`. The parent resource's properties become the
-     :term:`nested stack's <nested stack>` parameters. See `What are
+     :term:`nested stack's <nested stack>` parameters.
-     "Providers"? (OpenStack Wiki)`_.
-
-     .. _`What are "Providers"? (OpenStack Wiki)`: https://wiki.openstack.org/wiki/Heat/Providers#What_are_.22Providers.22.3F
 
    Provider template
      Allows user-definable :term:`resource providers <resource
@@ -130,7 +127,7 @@
      A :term:`resource property` that contains CFN-style template
      metadata. See `AWS::CloudFormation::Init (AWS CloudFormation User Guide)`_
 
-     .. _AWS::CloudFormation::Init (AWS CloudFormation User Guide): http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-init.html
+     .. _AWS::CloudFormation::Init (AWS CloudFormation User Guide): https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-init.html
 
    Resource plugin
      Python code that understands how to instantiate and manage a
@@ -169,7 +166,7 @@
      End User Guide)`_.
 
      .. _User data (OpenStack End User Guide): https://docs.openstack.org/nova/latest/user/user-data.html
-     .. _cloud-init: https://help.ubuntu.com/community/CloudInit
+     .. _cloud-init: https://cloudinit.readthedocs.io/
 
    Wait condition
      A :term:`resource provider` that provides a way to communicate

doc/source/install/index.rst

@@ -15,5 +15,4 @@ The Orchestration service (heat) uses a :ref:`Heat Orchestration Template (HOT)
 <hot_guide>` to create and manage cloud resources.
 
 This chapter assumes a working setup of OpenStack following the
-`OpenStack Installation Tutorial <http://docs.openstack.org/#install-guides>`_.
+`OpenStack Installation Tutorial <https://docs.openstack.org/#install-guides>`_.
-

doc/source/install/next-steps.rst

@@ -6,7 +6,7 @@ Next steps
 Your OpenStack environment now includes the heat service.
 
 To add more services, see the
-`additional documentation on installing OpenStack <http://docs.openstack.org/#install-guides>`_ .
+`additional documentation on installing OpenStack <https://docs.openstack.org/#install-guides>`_.
 
 To learn more about the heat service, read the :doc:`Heat documentation
 <../index>`.

doc/source/operating_guides/httpd.rst

@@ -98,5 +98,5 @@ file.
 
 The dsvm jobs in heat upstream gate uses this deployment method.
 
-For more details on using mod_proxy_uwsgi see the official docs:
+For more details on using mod_proxy_uwsgi see the `official docs
-http://uwsgi-docs.readthedocs.io/en/latest/Apache.html?highlight=mod_uwsgi_proxy#mod-proxy-uwsgi
+<https://uwsgi-docs.readthedocs.io/en/latest/Apache.html?highlight=mod_uwsgi_proxy#mod-proxy-uwsgi>`_.

doc/source/operating_guides/scale_deployment.rst

@@ -35,7 +35,7 @@ This guide, using a devstack installation of OpenStack, assumes that:
        <https://docs.openstack.org/devstack/latest/guides/single-machine.html>`_;
     2. You have set up heat on devstack, as defined at :doc:`heat and DevStack
        <../getting_started/on_devstack>`;
-    3. You have installed `HAProxy <http://haproxy.1wt.eu>`_ on the devstack
+    3. You have installed HAProxy_ on the devstack
        server.
 
 Architecture
@@ -63,7 +63,7 @@ As there is a need to use a load balancer mechanism between the multiple APIs
 and the CLI, a proxy has to be deployed.
 
 Because the heat CLI and APIs communicate by exchanging HTTP requests and
-responses, a `HAProxy <http://haproxy.1wt.eu>`_ HTTP load balancer server will
+responses, a HAProxy_ HTTP load balancer server will
 be deployed between them.
 
 This way, the proxy will take the CLIs requests to the APIs and act on their
@@ -352,3 +352,5 @@ On the machine A, kill the *heat-api* and *heat-api-cfn* processes by running
         option  httpchk
         server cfn-server-1 10.0.0.2:8000
         server cfn-server-2 10.0.0.3:8000
+
+.. _HAProxy: https://www.haproxy.org/

doc/source/template_guide/existing_templates.rst

@@ -25,4 +25,4 @@ building a multi-node OpenStack cluster, as well as templates for CI
 development. Heat templates for deployment of Magento, Hadoop, MongoDB,
 ELK, Drupal and more can be found here.
 
-.. _RCB Ops repository: http://github.com/rcbops/
+.. _RCB Ops repository: https://github.com/rcbops?q=RPC-Heat

doc/source/template_guide/software_deployment.rst

@@ -53,9 +53,9 @@ to be passed to that server. This user-data is made available either from
 configured config-drive or from the `Metadata service`_.
 
 How this user-data is consumed depends on the image being booted, but the most
-commonly used tool for default cloud images is Cloud-init_.
+commonly used tool for default cloud images is cloud-init_.
 
-Whether the image is using Cloud-init_ or not, it should be possible to
+Whether the image is using cloud-init_ or not, it should be possible to
 specify a shell script in the ``user_data`` property and have it be executed by
 the server during boot:
 
@@ -141,7 +141,7 @@ cloud-init boot configuration data. While ``HEAT_CFNTOOLS`` is the default
 for ``user_data_format``, it is considered legacy and ``RAW`` or
 ``SOFTWARE_CONFIG`` will generally be more appropriate.
 
-For ``RAW`` the user_data is passed to Nova unmodified. For a Cloud-init_
+For ``RAW`` the user_data is passed to Nova unmodified. For a cloud-init_
 enabled image, the following are both valid ``RAW`` user-data:
 
 .. code-block:: yaml
@@ -357,7 +357,7 @@ represented by text scripts, for example:
           user_data_format: SOFTWARE_CONFIG
           user_data: {get_resource: boot_script}
 
-The resource :ref:`OS::Heat::CloudConfig` allows Cloud-init_ cloud-config to
+The resource :ref:`OS::Heat::CloudConfig` allows cloud-init_ cloud-config to
 be represented as template YAML rather than a block string. This allows
 intrinsic functions to be included when building the cloud-config. This also
 ensures that the cloud-config is valid YAML, although no further checks for
@@ -388,7 +388,7 @@ valid cloud-config are done.
 
 The resource :ref:`OS::Heat::MultipartMime` allows multiple
 :ref:`OS::Heat::SoftwareConfig` and :ref:`OS::Heat::CloudConfig`
-resources to be combined into a single Cloud-init_ multi-part message:
+resources to be combined into a single cloud-init_ multi-part message:
 
 .. code-block:: yaml
 
@@ -779,14 +779,14 @@ contents of the file ``example-puppet-manifest.pp``, containing:
 
 
 .. _`AWS::CloudFormation::Init`: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-init.html
-.. _diskimage-builder: https://git.openstack.org/cgit/openstack/diskimage-builder
+.. _diskimage-builder: https://docs.openstack.org/diskimage-builder/latest/
-.. _imagefactory: http://imgfac.org/
+.. _imagefactory: https://imgfac.org/
 .. _`Metadata service`: https://docs.openstack.org/nova/latest/admin/networking-nova.html#metadata-service
-.. _Cloud-init: http://cloudinit.readthedocs.org/en/latest/
+.. _cloud-init: https://cloudinit.readthedocs.io/
-.. _curl: http://curl.haxx.se/
+.. _curl: https://curl.haxx.se/
-.. _`Orchestration API`: http://developer.openstack.org/api-ref/orchestration/v1/
+.. _`Orchestration API`: https://developer.openstack.org/api-ref/orchestration/v1/
 .. _os-refresh-config: https://git.openstack.org/cgit/openstack/os-refresh-config
 .. _os-apply-config: https://git.openstack.org/cgit/openstack/os-apply-config
 .. _tripleo-heat-templates: https://git.openstack.org/cgit/openstack/tripleo-heat-templates
 .. _tripleo-image-elements: https://git.openstack.org/cgit/openstack/tripleo-image-elements
-.. _puppet: http://puppetlabs.com/
+.. _puppet: https://puppet.com/

heat/common/i18n.py

@@ -14,7 +14,8 @@
 # limitations under the License.
 
 # It's based on oslo.i18n usage in OpenStack Keystone project and
-# recommendations from http://docs.openstack.org/developer/oslo.i18n/usage.html
+# recommendations from
+# https://docs.openstack.org/oslo.i18n/latest/user/usage.html
 
 import six
 

heat/engine/template.py

@@ -301,7 +301,7 @@ class Template(collections.Mapping):
         # TODO(kanagaraj-manickam) currently t_digest is stored in self. which
         # is used to check whether already template is validated or not.
         # But it needs to be loaded from dogpile cache backend once its
-        # available in heat (http://specs.openstack.org/openstack/heat-specs/
+        # available in heat (https://specs.openstack.org/openstack/heat-specs/
         # specs/liberty/constraint-validation-cache.html). This is required
         # as multiple heat-engines may process the same template at least
         # in case of instance_group. And it fixes partially bug 1444316

setup.cfg

@@ -5,7 +5,7 @@ description-file =
     README.rst
 author = OpenStack
 author-email = openstack-dev@lists.openstack.org
-home-page = http://docs.openstack.org/developer/heat/
+home-page = https://docs.openstack.org/heat/latest/
 classifier =
     Environment :: OpenStack
     Intended Audience :: Information Technology

tools/README.rst

@@ -1,7 +1,7 @@
 Files in this directory are general developer tools or examples of how
 to do certain activities.
 
-If you're running on Fedora, see the instructions at http://docs.openstack.org/developer/heat/getting_started/on_fedora.html
+If you're running on Fedora, see the instructions at https://docs.openstack.org/heat/latest/getting_started/on_fedora.html
 
 Tools
 =====