Skip to content

Commit

Permalink
Merge branch 'master' into 3.8.fp8
Browse files Browse the repository at this point in the history
Conflicts:
	apis/en/source/pages/application.wadl
  • Loading branch information
AliceAlbano committed Nov 13, 2018
2 parents 669df06 + 348d624 commit 772bd1b
Show file tree
Hide file tree
Showing 74 changed files with 9,516 additions and 7,997 deletions.
2 changes: 1 addition & 1 deletion admin/en/source/pages/install/configure-uforge.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ For incoming:
* 80 and 443
* 22

In addition, communication ports between UForge and the cloud platform to which you will publish the images have to be open and depend entirely on your cloud platform configuration, see :ref:`cloud-platform-default-ports` for more information.
In addition, communication ports between UForge and the cloud platform to which you will publish the images have to be open and depend entirely on your cloud platform configuration, see :ref:`cloud-platform-default-ports` for more information. All other ports not in this list should be blocked by the firewall to protect internal services from outside access.

Configuring NTP
~~~~~~~~~~~~~~~
Expand Down
1 change: 1 addition & 0 deletions apis/en/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ This documentation provides a description of UForge AppCenter RESTful interface.
pages/artifactaccounts/overview
pages/blueprint/overview
pages/categories/overview
pages/containers/overview
pages/deployments/overview
pages/machineimage/overview
pages/machinemigration/overview
Expand Down
16,284 changes: 8,295 additions & 7,989 deletions apis/en/source/pages/application.wadl

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
.. Copyright 2018 FUJITSU LIMITED
.. _containerTemplateImageGeneration-cancel:

containerTemplateImageGeneration_cancel
---------------------------------------

.. function:: DELETE /users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/status

.. sidebar:: Summary

* Method: ``DELETE``
* Response Code: ``204 / 200``
* Response Formats: ``application/xml`` ``application/json``
* Since: ``UForge 3.8.8``

Cancels a running generation of a machine image generated from a container template.

Security Summary
~~~~~~~~~~~~~~~~

* Requires Authentication: ``true``
* Entitlements Required: ``image_generate``

URI Parameters
~~~~~~~~~~~~~~

* ``uid`` (required): the user name (login name) of the :ref:`user-object`
* ``msid`` (required): the id of the :ref:`mySoftware-object`
* ``tiid`` (required): the id of the :ref:`image-object`
* ``tid`` (required): the id of the :ref:`containertemplate-object`

HTTP Request Body Parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

None

Example Request
~~~~~~~~~~~~~~~

.. code-block:: bash
curl "https://uforge.example.com/api/users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/status" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"
.. seealso::

* :ref:`containerTemplateImageGeneration-get`
* :ref:`containerTemplateImagePublish-cancel`
* :ref:`containerTemplateImagePublish-get`
* :ref:`containerTemplateImagePublished-delete`
* :ref:`containerTemplateImagePublished-get`
* :ref:`containerTemplateImage-delete`
* :ref:`containerTemplateImage-download`
* :ref:`containerTemplateImage-downloadFile`
* :ref:`containerTemplateImage-get`
* :ref:`containerTemplateImage-publish`
* :ref:`containerTemplate-create`
* :ref:`containerTemplate-generate`
* :ref:`containerTemplate-get`
* :ref:`containertemplate-object`
* :ref:`image-object`
* :ref:`mySoftware-object`
* :ref:`status-object`
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
.. Copyright 2018 FUJITSU LIMITED
.. _containerTemplateImageGeneration-get:

containerTemplateImageGeneration_get
------------------------------------

.. function:: GET /users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/status

.. sidebar:: Summary

* Method: ``GET``
* Response Code: ``200 / 304``
* Response Formats: ``application/xml`` ``application/json``
* Since: ``UForge 3.8.8``

Retrieves the generation status of a machine image generated from a container template.

Security Summary
~~~~~~~~~~~~~~~~

* Requires Authentication: ``true``
* Entitlements Required: ``appliance_create``

URI Parameters
~~~~~~~~~~~~~~

* ``uid`` (required): the user name (login name) of the :ref:`user-object`
* ``msid`` (required): the id of the :ref:`mySoftware-object`
* ``tiid`` (required): the id of the :ref:`image-object`
* ``tid`` (required): the id of the :ref:`containertemplate-object`

HTTP Request Body Parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

None

Example Request
~~~~~~~~~~~~~~~

.. code-block:: bash
curl "https://uforge.example.com/api/users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/status" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"
.. seealso::

* :ref:`containerTemplateImageGeneration-cancel`
* :ref:`containerTemplateImagePublish-cancel`
* :ref:`containerTemplateImagePublish-get`
* :ref:`containerTemplateImagePublished-delete`
* :ref:`containerTemplateImagePublished-get`
* :ref:`containerTemplateImage-delete`
* :ref:`containerTemplateImage-download`
* :ref:`containerTemplateImage-downloadFile`
* :ref:`containerTemplateImage-get`
* :ref:`containerTemplateImage-publish`
* :ref:`containerTemplate-create`
* :ref:`containerTemplate-generate`
* :ref:`containerTemplate-get`
* :ref:`containertemplate-object`
* :ref:`image-object`
* :ref:`mySoftware-object`
* :ref:`status-object`
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
.. Copyright 2018 FUJITSU LIMITED
.. _containerTemplateImagePublish-cancel:

containerTemplateImagePublish_cancel
------------------------------------

.. function:: DELETE /users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/pimages/{ptiid}/cancel

.. sidebar:: Summary

* Method: ``DELETE``
* Response Code: ``204 / 200``
* Response Formats: ``application/xml`` ``application/json``
* Since: ``UForge 3.8.8``

Cancels a running publish of a machine image generated from a container template.

Security Summary
~~~~~~~~~~~~~~~~

* Requires Authentication: ``true``
* Entitlements Required: ``image_publish``

URI Parameters
~~~~~~~~~~~~~~

* ``ptiid`` (required): the id of the :ref:`publishimage-object`
* ``uid`` (required): the user name (login name) of the :ref:`user-object`
* ``msid`` (required): the id of the :ref:`mySoftware-object`
* ``tiid`` (required): the id of the :ref:`image-object`
* ``tid`` (required): the id of the :ref:`containertemplate-object`

HTTP Request Body Parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

None

Example Request
~~~~~~~~~~~~~~~

.. code-block:: bash
curl "https://uforge.example.com/api/users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/pimages/{ptiid}/cancel" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"
.. seealso::

* :ref:`containerTemplateImageGeneration-cancel`
* :ref:`containerTemplateImageGeneration-get`
* :ref:`containerTemplateImagePublish-get`
* :ref:`containerTemplateImagePublished-delete`
* :ref:`containerTemplateImagePublished-get`
* :ref:`containerTemplateImage-delete`
* :ref:`containerTemplateImage-download`
* :ref:`containerTemplateImage-downloadFile`
* :ref:`containerTemplateImage-get`
* :ref:`containerTemplateImage-publish`
* :ref:`containerTemplate-create`
* :ref:`containerTemplate-generate`
* :ref:`containerTemplate-get`
* :ref:`containertemplate-object`
* :ref:`mySoftware-object`
* :ref:`status-object`
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
.. Copyright 2018 FUJITSU LIMITED
.. _containerTemplateImagePublish-get:

containerTemplateImagePublish_get
---------------------------------

.. function:: GET /users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/pimages/{ptiid}/status

.. sidebar:: Summary

* Method: ``GET``
* Response Code: ``200 / 304``
* Response Formats: ``application/xml`` ``application/json``
* Since: ``UForge 3.8.8``

Retrieves the publish status of a machine image generated from a container template.

Security Summary
~~~~~~~~~~~~~~~~

* Requires Authentication: ``true``
* Entitlements Required: ``image_publish``

URI Parameters
~~~~~~~~~~~~~~

* ``ptiid`` (required): the id of the :ref:`publishimage-object`
* ``uid`` (required): the user name (login name) of the :ref:`user-object`
* ``msid`` (required): the id of the :ref:`mySoftware-object`
* ``tiid`` (required): the id of the :ref:`image-object`
* ``tid`` (required): the id of the :ref:`containertemplate-object`

HTTP Request Body Parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

None

Example Request
~~~~~~~~~~~~~~~

.. code-block:: bash
curl "https://uforge.example.com/api/users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/pimages/{ptiid}/status" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"
.. seealso::

* :ref:`containerTemplateImageGeneration-cancel`
* :ref:`containerTemplateImageGeneration-get`
* :ref:`containerTemplateImagePublish-cancel`
* :ref:`containerTemplateImagePublished-delete`
* :ref:`containerTemplateImagePublished-get`
* :ref:`containerTemplateImage-delete`
* :ref:`containerTemplateImage-download`
* :ref:`containerTemplateImage-downloadFile`
* :ref:`containerTemplateImage-get`
* :ref:`containerTemplateImage-publish`
* :ref:`containerTemplate-create`
* :ref:`containerTemplate-generate`
* :ref:`containerTemplate-get`
* :ref:`containertemplate-object`
* :ref:`mySoftware-object`
* :ref:`status-object`
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
.. Copyright 2018 FUJITSU LIMITED
.. _containerTemplateImagePublished-delete:

containerTemplateImagePublished_delete
--------------------------------------

.. function:: DELETE /users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/pimages/{ptiid}

.. sidebar:: Summary

* Method: ``DELETE``
* Response Code: ``204 / 200``
* Response Formats:
* Since: ``UForge 3.8.8``

Deletes a published machine image for a container template.

Security Summary
~~~~~~~~~~~~~~~~

* Requires Authentication: ``true``
* Entitlements Required: ``image_publish``

URI Parameters
~~~~~~~~~~~~~~

* ``ptiid`` (required): the id of the :ref:`publishimage-object`
* ``uid`` (required): the user name (login name) of the :ref:`user-object`
* ``msid`` (required): the id of the :ref:`mySoftware-object`
* ``tiid`` (required): the id of the :ref:`image-object`
* ``tid`` (required): the id of the :ref:`containertemplate-object`

HTTP Request Body Parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

None

Example Request
~~~~~~~~~~~~~~~

.. code-block:: bash
curl "https://uforge.example.com/api/users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/pimages/{ptiid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"
.. seealso::

* :ref:`containerTemplateImageGeneration-cancel`
* :ref:`containerTemplateImageGeneration-get`
* :ref:`containerTemplateImagePublish-cancel`
* :ref:`containerTemplateImagePublish-get`
* :ref:`containerTemplateImagePublished-get`
* :ref:`containerTemplateImage-delete`
* :ref:`containerTemplateImage-download`
* :ref:`containerTemplateImage-downloadFile`
* :ref:`containerTemplateImage-get`
* :ref:`containerTemplateImage-publish`
* :ref:`containerTemplate-create`
* :ref:`containerTemplate-generate`
* :ref:`containerTemplate-get`
* :ref:`containertemplate-object`
* :ref:`mySoftware-object`

0 comments on commit 772bd1b

Please sign in to comment.