From 3f98c3d6fbe23999d34ad2eef0315a2f2b0a6637 Mon Sep 17 00:00:00 2001 From: Zane Bitter Date: Mon, 12 Mar 2018 13:56:01 -0400 Subject: [PATCH] Docs: modernise links Switch to https, replace outdated URLs with canonical ones. Change-Id: I7c474dbf0b21f922b6625e31d6ae7df1e198b8de Co-Authored-By: chenghuiyu Co-Authored-By: Max Pavlukhin Co-Authored-By: yfzhao Co-Authored-By: ricolin --- HACKING.rst | 2 +- README.rst | 24 ++++++++++--------- contrib/heat_docker/setup.cfg | 2 +- doc/source/contributing/blueprints.rst | 4 ++-- doc/source/developing_guides/architecture.rst | 4 ++-- doc/source/developing_guides/gmr.rst | 3 +-- doc/source/getting_started/on_devstack.rst | 2 +- doc/source/getting_started/on_fedora.rst | 8 +++---- doc/source/getting_started/on_ubuntu.rst | 7 +++--- doc/source/glossary.rst | 9 +++---- doc/source/install/index.rst | 3 +-- doc/source/install/next-steps.rst | 2 +- doc/source/operating_guides/httpd.rst | 4 ++-- .../operating_guides/scale_deployment.rst | 6 +++-- .../template_guide/existing_templates.rst | 2 +- .../template_guide/software_deployment.rst | 22 ++++++++--------- heat/common/i18n.py | 3 ++- heat/engine/template.py | 2 +- setup.cfg | 2 +- tools/README.rst | 2 +- 20 files changed, 57 insertions(+), 56 deletions(-) diff --git a/HACKING.rst b/HACKING.rst index 854e563a72..9b0cadee5c 100644 --- a/HACKING.rst +++ b/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 diff --git a/README.rst b/README.rst index bfec829632..0264a6f50e 100644 --- a/README.rst +++ b/README.rst @@ -2,8 +2,8 @@ Team and repository tags ======================== -.. image:: http://governance.openstack.org/badges/heat.svg - :target: http://governance.openstack.org/reference/tags/index.html +.. image:: https://governance.openstack.org/tc/badges/heat.svg + :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 -* Developer docs: http://docs.openstack.org/heat/latest +* Documentation: https://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 -* http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide/create-stack.html -* http://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://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_CreateStack.html +* https://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide/create-stack.html +* https://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html +* 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) diff --git a/contrib/heat_docker/setup.cfg b/contrib/heat_docker/setup.cfg index f8255b58d9..7e56e1531b 100644 --- a/contrib/heat_docker/setup.cfg +++ b/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 diff --git a/doc/source/contributing/blueprints.rst b/doc/source/contributing/blueprints.rst index c95505b1a0..a860438b81 100644 --- a/doc/source/contributing/blueprints.rst +++ b/doc/source/contributing/blueprints.rst @@ -2,13 +2,13 @@ Blueprints and Specs ==================== The Heat team uses the `heat-specs -`_ repository for its +`_ repository for its specification reviews. Detailed information can be found `here `_. Please note that we use a template for spec submissions. Please use the `template for the latest release -`_. +`_. It is not required to fill out all sections in the template. Spec Notes diff --git a/doc/source/developing_guides/architecture.rst b/doc/source/developing_guides/architecture.rst index 4860ee6d90..17ba51040e 100644 --- a/doc/source/developing_guides/architecture.rst +++ b/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 -.. _`AWS CloudFormation`: http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/Welcome.html?r=7078 +.. _Chef: https://www.full360.com/2011/02/27/integrating-aws-cloudformation-and-chef.html +.. _`AWS CloudFormation`: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/Welcome.html?r=7078 diff --git a/doc/source/developing_guides/gmr.rst b/doc/source/developing_guides/gmr.rst index a8b8b3a594..f2daeaae87 100644 --- a/doc/source/developing_guides/gmr.rst +++ b/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 `_ +`oslo.reports `_ diff --git a/doc/source/getting_started/on_devstack.rst b/doc/source/getting_started/on_devstack.rst index 4271576805..666683f280 100644 --- a/doc/source/getting_started/on_devstack.rst +++ b/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 diff --git a/doc/source/getting_started/on_fedora.rst b/doc/source/getting_started/on_fedora.rst index 316f02acd5..618093b120 100644 --- a/doc/source/getting_started/on_fedora.rst +++ b/doc/source/getting_started/on_fedora.rst @@ -14,10 +14,10 @@ Installing OpenStack and Heat on RHEL/Fedora/CentOS --------------------------------------------------- -Go to the `OpenStack Documentation `_ for -the latest version of the Installation Guide for Red Hat Enterprise -Linux, CentOS and Fedora which includes a chapter on installing the -Orchestration module (Heat). +Go to the `OpenStack Documentation +`_ for the latest version of the +Installation Guide for Red Hat Enterprise Linux, CentOS and Fedora which +includes a chapter on installing the Orchestration module (Heat). There are instructions for `installing the RDO OpenStack `_ on Fedora and CentOS. diff --git a/doc/source/getting_started/on_ubuntu.rst b/doc/source/getting_started/on_ubuntu.rst index a0e6a7f5db..773136c8bf 100644 --- a/doc/source/getting_started/on_ubuntu.rst +++ b/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 `_ for -the latest version of the Installation Guide for Ubuntu which includes a -chapter on installing the Orchestration module (Heat). +Go to the `OpenStack Documentation +`_ for the latest version of the +Installation Guide for Ubuntu which includes a chapter on installing the +Orchestration module (Heat). There is a `Juju Charm for Heat ` available. diff --git a/doc/source/glossary.rst b/doc/source/glossary.rst index 6556f1da82..304bc1b467 100644 --- a/doc/source/glossary.rst +++ b/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 ` parameters. See `What are - "Providers"? (OpenStack Wiki)`_. - - .. _`What are "Providers"? (OpenStack Wiki)`: https://wiki.openstack.org/wiki/Heat/Providers#What_are_.22Providers.22.3F + :term:`nested stack's ` parameters. Provider template Allows user-definable :term:`resource providers ` to create and manage cloud resources. This chapter assumes a working setup of OpenStack following the -`OpenStack Installation Tutorial `_. - +`OpenStack Installation Tutorial `_. diff --git a/doc/source/install/next-steps.rst b/doc/source/install/next-steps.rst index 2e9cca6b62..83df8c2933 100644 --- a/doc/source/install/next-steps.rst +++ b/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 `_ . +`additional documentation on installing OpenStack `_. To learn more about the heat service, read the :doc:`Heat documentation <../index>`. diff --git a/doc/source/operating_guides/httpd.rst b/doc/source/operating_guides/httpd.rst index 1f3eae327a..3ab0540c35 100644 --- a/doc/source/operating_guides/httpd.rst +++ b/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: -http://uwsgi-docs.readthedocs.io/en/latest/Apache.html?highlight=mod_uwsgi_proxy#mod-proxy-uwsgi +For more details on using mod_proxy_uwsgi see the `official docs +`_. diff --git a/doc/source/operating_guides/scale_deployment.rst b/doc/source/operating_guides/scale_deployment.rst index 30a6865aba..ffcc77d621 100644 --- a/doc/source/operating_guides/scale_deployment.rst +++ b/doc/source/operating_guides/scale_deployment.rst @@ -35,7 +35,7 @@ This guide, using a devstack installation of OpenStack, assumes that: `_; 2. You have set up heat on devstack, as defined at :doc:`heat and DevStack <../getting_started/on_devstack>`; - 3. You have installed `HAProxy `_ 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 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/ diff --git a/doc/source/template_guide/existing_templates.rst b/doc/source/template_guide/existing_templates.rst index 711c24a450..7715bd5842 100644 --- a/doc/source/template_guide/existing_templates.rst +++ b/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 diff --git a/doc/source/template_guide/software_deployment.rst b/doc/source/template_guide/software_deployment.rst index 26826dd477..85d30300ce 100644 --- a/doc/source/template_guide/software_deployment.rst +++ b/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 -.. _imagefactory: http://imgfac.org/ +.. _diskimage-builder: https://docs.openstack.org/diskimage-builder/latest/ +.. _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/ -.. _curl: http://curl.haxx.se/ -.. _`Orchestration API`: http://developer.openstack.org/api-ref/orchestration/v1/ +.. _cloud-init: https://cloudinit.readthedocs.io/ +.. _curl: https://curl.haxx.se/ +.. _`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/ diff --git a/heat/common/i18n.py b/heat/common/i18n.py index 81183e1199..e2c423cb08 100644 --- a/heat/common/i18n.py +++ b/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 diff --git a/heat/engine/template.py b/heat/engine/template.py index 8493e4069e..bcc851b7b7 100644 --- a/heat/engine/template.py +++ b/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 diff --git a/setup.cfg b/setup.cfg index be6863e98e..15ccf8e460 100644 --- a/setup.cfg +++ b/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 diff --git a/tools/README.rst b/tools/README.rst index 7bade8685d..ab24decd71 100644 --- a/tools/README.rst +++ b/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 =====