Merge branch 'documentation/ZENKO-3656/remove_s3_endpoint' into q/2.1

docs/docsource/operation/platform_operations/create_an_s3_endpoint.rst

@@ -3,10 +3,54 @@
 Create an S3 Endpoint
 =====================
 
-To create an S3 endpoint from the command line:
+Create an S3 Endpoint from the UI
+---------------------------------
+
+#. From the |product| home screen, select the **Data Services** tab.
+
+#. Click the **+ Create Data Service** button.
+
+   .. image:: ../../graphics/create_endpoint.png
+
+#. Enter a descriptive **Hostname** and select a location from the **Select Storage Location** drop down menu. 
+
+   .. note::
+
+      If no location is specified when creating a bucket from the S3-API, this endpoint 
+      location will be used to store objects.
+
+   .. image:: ../../graphics/create_endpoint_options.png
+
+#. Click the **Create** button. The **Deploying Data Service** spinner appears.
+
+#. Check that the created endpoint is listed. 
+
+   .. image:: ../../graphics/endpoint_created.png
+
+
+Create an S3 Endpoint from the Command Line
+----------------------------------------------
 
 #. Retrieve tokens as described in :ref:`Retrieve Access Tokens`.
 
+#. Define a hostname. For more information refer to: 
+
+   - `Rules for naming Amazon S3 access points <https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-access-points.html#access-points-names>`_.
+
+   - `rfc 1123 - Requirements for Internet Hosts <https://datatracker.ietf.org/doc/html/rfc1123/>`_
+
+   - `rfc 1034 - Domain Names <https://datatracker.ietf.org/doc/html/rfc1034#section-4.3.3>`_
+
+   .. code::
+
+      ENDPOINT_HOSTNAME="hostname"
+
+#. Define storage location. For more information refer to :ref:`Add a Storage Location`.
+
+   .. code::
+
+      LOCATION_NAME="location" 
+
 #. Issue the following variable declarations and commands:
 
    .. code::
@@ -23,5 +67,5 @@ To create an S3 endpoint from the command line:
           -H "X-Authentication-Token: ${TOKEN}" \
           -H "Content-Type: application/json" \
           -d "${ENDPOINT_PARAMS}" \
-          "http://management.zenko.local/api/v1/config/${INSTANCE_ID}/endpoint" | \
+          "https://management.zenko.workloadplane.scality.local/api/v1/config/${INSTANCE_ID}/endpoint" | \ 
           jq '.'

docs/docsource/operation/platform_operations/delete_an_s3_endpoint.rst

@@ -0,0 +1,54 @@
+.. _Delete an S3 endpoint:
+
+Delete an S3 Endpoint
+=====================
+
+Delete an S3 Endpoint from the UI
+---------------------------------
+
+#. From the |product| home screen, select the **Data Services** tab.
+
+#. Click the red trash can corresponding to the endpoint you want to delete, and click **Delete** on the confirmation popup.
+
+   .. image:: ../../graphics/endpoint_created.png
+
+#. Check that the deleted endpoint is no longer listed.
+
+   .. image:: ../../graphics/create_endpoint.png
+
+
+Delete an S3 Endpoint from the Command Line
+-------------------------------------------
+
+#. Retrieve tokens as described in :ref:`Retrieve Access Tokens`.
+
+#. Retrieve the list of all endpoints and hostnames.
+
+   .. code::
+
+      kubectl -n zenko get zenkoconfigurationoverlay -o jsonpath='{.items[-1].spec.s3API.endpoints[*]}' \
+        --sort-by='{.metadata.creationTimestamp}'
+
+#. Select the hostname to delete.
+
+   .. code::
+
+      HOSTNAME="hostname to delete"
+
+#. Send a delete request to the management S3-API.
+
+   .. code::
+
+       curl -s -k -X DELETE -H "X-Authentication-Token: ${TOKEN}" "https://management.zenko.workloadplane.scality.local/api/v1/config/${INSTANCE_ID}/endpoint/${HOSTNAME}"
+
+#. Check that the endpoint has been deleted.
+
+   .. code::
+
+      kubectl -n zenko get zenkoconfigurationoverlay -o jsonpath='{range .items[-1].spec.s3API.endpoints[*]}{}{"\n"}{end}' --sort-by='{.metadata.creationTimestamp}'                               
+
+   After a few moments, all pods will be in a running state.
+
+   .. code::
+
+      kubectl -n zenko get pods 

docs/docsource/operation/platform_operations/index.rst

@@ -4,9 +4,19 @@ Platform Operations
 ===================
 
 The operations described here pertain to the operation and maintenance of the
-|product| platform. Using command-line operations, you can :ref:`Create an
-Ingress Endpoint`, :ref:`Retrieve Access Tokens`, :ref:`Create an Account`,
-:ref:`Create an S3 Endpoint`, and :ref:`Generate Root User Account Access Keys`.
+|product| platform. Using command-line operations, you can: 
+
+- :ref:`Create an Ingress Endpoint`
+
+- :ref:`Retrieve Access Tokens` 
+
+- :ref:`Create an Account`
+
+- :ref:`Create an S3 Endpoint`
+
+- :ref:`Delete an S3 Endpoint`
+
+- :ref:`Generate Root User Account Access Keys`
 
 .. toctree::
    :hidden:
@@ -15,4 +25,5 @@ Ingress Endpoint`, :ref:`Retrieve Access Tokens`, :ref:`Create an Account`,
    create_an_ingress_endpoint	      
    retrieve_access_tokens
    create_an_s3_endpoint
+   delete_an_s3_endpoint
    generate_an_account_root_access_key