Merge "[DOCS] Clean up docs etc"
diff --git a/docs/Access_Rancher_server_via_web_browser.jpeg b/docs/Access_Rancher_server_via_web_browser.jpeg
deleted file mode 100644
index 103fc27..0000000
--- a/docs/Access_Rancher_server_via_web_browser.jpeg
+++ /dev/null
Binary files differ
diff --git a/docs/Add_Kubernetes_Environment_to_Rancher.png b/docs/Add_Kubernetes_Environment_to_Rancher.png
deleted file mode 100644
index 0d60f15..0000000
--- a/docs/Add_Kubernetes_Environment_to_Rancher.png
+++ /dev/null
Binary files differ
diff --git a/docs/Apply_customization_script_for_the_Rancher_VM.jpeg b/docs/Apply_customization_script_for_the_Rancher_VM.jpeg
deleted file mode 100644
index 832dda3..0000000
--- a/docs/Apply_customization_script_for_the_Rancher_VM.jpeg
+++ /dev/null
Binary files differ
diff --git a/docs/Click_create.jpeg b/docs/Click_create.jpeg
deleted file mode 100644
index fad1856..0000000
--- a/docs/Click_create.jpeg
+++ /dev/null
Binary files differ
diff --git a/docs/Click_on_CLI_and_then_click_on_Generate_Config.jpeg b/docs/Click_on_CLI_and_then_click_on_Generate_Config.jpeg
deleted file mode 100644
index fec6a35..0000000
--- a/docs/Click_on_CLI_and_then_click_on_Generate_Config.jpeg
+++ /dev/null
Binary files differ
diff --git a/docs/Click_on_Close_button.jpeg b/docs/Click_on_Close_button.jpeg
deleted file mode 100644
index cb02480..0000000
--- a/docs/Click_on_Close_button.jpeg
+++ /dev/null
Binary files differ
diff --git a/docs/Click_on_Copy_to_Clipboard-wait_until_you_see_a_token-do_not_copy_user+password-the_server_is_not_ready_at_that_point.jpeg b/docs/Click_on_Copy_to_Clipboard-wait_until_you_see_a_token-do_not_copy_user+password-the_server_is_not_ready_at_that_point.jpeg
deleted file mode 100644
index bb0f60c..0000000
--- a/docs/Click_on_Copy_to_Clipboard-wait_until_you_see_a_token-do_not_copy_user+password-the_server_is_not_ready_at_that_point.jpeg
+++ /dev/null
Binary files differ
diff --git a/docs/K8s-Assign_Floating_IP_for_external_access.jpeg b/docs/K8s-Assign_Floating_IP_for_external_access.jpeg
deleted file mode 100644
index fe84d11..0000000
--- a/docs/K8s-Assign_Floating_IP_for_external_access.jpeg
+++ /dev/null
Binary files differ
diff --git a/docs/K8s-Key_Pair.jpeg b/docs/K8s-Key_Pair.jpeg
deleted file mode 100644
index 1e335d3..0000000
--- a/docs/K8s-Key_Pair.jpeg
+++ /dev/null
Binary files differ
diff --git a/docs/K8s-Launch_Instance.jpeg b/docs/K8s-Launch_Instance.jpeg
deleted file mode 100644
index 7e2122c..0000000
--- a/docs/K8s-Launch_Instance.jpeg
+++ /dev/null
Binary files differ
diff --git a/docs/K8s-Launch_new_VM_instance_to_create_a_Kubernetes_single_host_or_cluster.jpeg b/docs/K8s-Launch_new_VM_instance_to_create_a_Kubernetes_single_host_or_cluster.jpeg
deleted file mode 100644
index 8d154d4..0000000
--- a/docs/K8s-Launch_new_VM_instance_to_create_a_Kubernetes_single_host_or_cluster.jpeg
+++ /dev/null
Binary files differ
diff --git a/docs/K8s-Manage_Floating_IP_Associations.jpeg b/docs/K8s-Manage_Floating_IP_Associations.jpeg
deleted file mode 100644
index f15e5e3..0000000
--- a/docs/K8s-Manage_Floating_IP_Associations.jpeg
+++ /dev/null
Binary files differ
diff --git a/docs/K8s-Networking.jpeg b/docs/K8s-Networking.jpeg
deleted file mode 100644
index ee4cafc..0000000
--- a/docs/K8s-Networking.jpeg
+++ /dev/null
Binary files differ
diff --git a/docs/K8s-Security_Group.jpeg b/docs/K8s-Security_Group.jpeg
deleted file mode 100644
index 5e85218..0000000
--- a/docs/K8s-Security_Group.jpeg
+++ /dev/null
Binary files differ
diff --git a/docs/K8s-Select_Flavor.jpeg b/docs/K8s-Select_Flavor.jpeg
deleted file mode 100644
index c3cf4b2..0000000
--- a/docs/K8s-Select_Flavor.jpeg
+++ /dev/null
Binary files differ
diff --git a/docs/K8s-Select_Ubuntu_16.04_as_base_image.jpeg b/docs/K8s-Select_Ubuntu_16.04_as_base_image.jpeg
deleted file mode 100644
index e9a03e7..0000000
--- a/docs/K8s-Select_Ubuntu_16.04_as_base_image.jpeg
+++ /dev/null
Binary files differ
diff --git a/docs/Rancher-Allocate_Floating_IP.jpeg b/docs/Rancher-Allocate_Floating_IP.jpeg
deleted file mode 100644
index 9d6ff3f..0000000
--- a/docs/Rancher-Allocate_Floating_IP.jpeg
+++ /dev/null
Binary files differ
diff --git a/docs/Rancher-Key_Pair.jpeg b/docs/Rancher-Key_Pair.jpeg
deleted file mode 100644
index 1bcb6b6..0000000
--- a/docs/Rancher-Key_Pair.jpeg
+++ /dev/null
Binary files differ
diff --git a/docs/Rancher-Launch_Instance.jpeg b/docs/Rancher-Launch_Instance.jpeg
deleted file mode 100644
index 3894369..0000000
--- a/docs/Rancher-Launch_Instance.jpeg
+++ /dev/null
Binary files differ
diff --git a/docs/Rancher-Launch_new_VM_instance_to_host_the_Rancher_Server.jpeg b/docs/Rancher-Launch_new_VM_instance_to_host_the_Rancher_Server.jpeg
deleted file mode 100644
index 2b3fde3..0000000
--- a/docs/Rancher-Launch_new_VM_instance_to_host_the_Rancher_Server.jpeg
+++ /dev/null
Binary files differ
diff --git a/docs/Rancher-Manage_Floating_IP_Associations.jpeg b/docs/Rancher-Manage_Floating_IP_Associations.jpeg
deleted file mode 100644
index ae062c1..0000000
--- a/docs/Rancher-Manage_Floating_IP_Associations.jpeg
+++ /dev/null
Binary files differ
diff --git a/docs/Rancher-Networking.jpeg b/docs/Rancher-Networking.jpeg
deleted file mode 100644
index 16ef380..0000000
--- a/docs/Rancher-Networking.jpeg
+++ /dev/null
Binary files differ
diff --git a/docs/Rancher-Security_Groups.jpeg b/docs/Rancher-Security_Groups.jpeg
deleted file mode 100644
index c8ff2e8..0000000
--- a/docs/Rancher-Security_Groups.jpeg
+++ /dev/null
Binary files differ
diff --git a/docs/Rancher-Select_Flavor.jpeg b/docs/Rancher-Select_Flavor.jpeg
deleted file mode 100644
index a3f35b5..0000000
--- a/docs/Rancher-Select_Flavor.jpeg
+++ /dev/null
Binary files differ
diff --git a/docs/Rancher-Select_Ubuntu_16.04_as_base_image.jpeg b/docs/Rancher-Select_Ubuntu_16.04_as_base_image.jpeg
deleted file mode 100644
index b80fae4..0000000
--- a/docs/Rancher-Select_Ubuntu_16.04_as_base_image.jpeg
+++ /dev/null
Binary files differ
diff --git a/docs/Return_to_Rancher_environment_eg_SB4_and_wait_for_services_to_complete_10-15_mins.jpeg b/docs/Return_to_Rancher_environment_eg_SB4_and_wait_for_services_to_complete_10-15_mins.jpeg
deleted file mode 100644
index 6d62b99..0000000
--- a/docs/Return_to_Rancher_environment_eg_SB4_and_wait_for_services_to_complete_10-15_mins.jpeg
+++ /dev/null
Binary files differ
diff --git a/docs/Select_Add_Environment.png b/docs/Select_Add_Environment.png
deleted file mode 100644
index 48fffa4..0000000
--- a/docs/Select_Add_Environment.png
+++ /dev/null
Binary files differ
diff --git a/docs/and_click_on_Save_accept_defaults.jpeg b/docs/and_click_on_Save_accept_defaults.jpeg
deleted file mode 100644
index 9b57927..0000000
--- a/docs/and_click_on_Save_accept_defaults.jpeg
+++ /dev/null
Binary files differ
diff --git a/docs/hardcoded_certificates.csv b/docs/certs/hardcoded_certificates.csv
similarity index 100%
rename from docs/hardcoded_certificates.csv
rename to docs/certs/hardcoded_certificates.csv
diff --git a/docs/helm-search.txt b/docs/helm/helm-search.txt
similarity index 100%
rename from docs/helm-search.txt
rename to docs/helm/helm-search.txt
diff --git a/docs/consulHealth.png b/docs/images/consul/consulHealth.png
similarity index 100%
rename from docs/consulHealth.png
rename to docs/images/consul/consulHealth.png
Binary files differ
diff --git a/docs/kubernetes_objects.png b/docs/images/k8s/kubernetes_objects.png
similarity index 100%
rename from docs/kubernetes_objects.png
rename to docs/images/k8s/kubernetes_objects.png
Binary files differ
diff --git a/docs/MSB-OOM-Diagram.png b/docs/images/msb/MSB-OOM-Diagram.png
similarity index 100%
rename from docs/MSB-OOM-Diagram.png
rename to docs/images/msb/MSB-OOM-Diagram.png
Binary files differ
diff --git a/docs/oomLogoV2-Configure.png b/docs/images/oom_logo/oomLogoV2-Configure.png
similarity index 100%
rename from docs/oomLogoV2-Configure.png
rename to docs/images/oom_logo/oomLogoV2-Configure.png
Binary files differ
diff --git a/docs/oomLogoV2-Delete.png b/docs/images/oom_logo/oomLogoV2-Delete.png
similarity index 100%
rename from docs/oomLogoV2-Delete.png
rename to docs/images/oom_logo/oomLogoV2-Delete.png
Binary files differ
diff --git a/docs/oomLogoV2-Deploy.png b/docs/images/oom_logo/oomLogoV2-Deploy.png
similarity index 100%
rename from docs/oomLogoV2-Deploy.png
rename to docs/images/oom_logo/oomLogoV2-Deploy.png
Binary files differ
diff --git a/docs/oomLogoV2-Heal.png b/docs/images/oom_logo/oomLogoV2-Heal.png
similarity index 100%
rename from docs/oomLogoV2-Heal.png
rename to docs/images/oom_logo/oomLogoV2-Heal.png
Binary files differ
diff --git a/docs/oomLogoV2-Monitor.png b/docs/images/oom_logo/oomLogoV2-Monitor.png
similarity index 100%
rename from docs/oomLogoV2-Monitor.png
rename to docs/images/oom_logo/oomLogoV2-Monitor.png
Binary files differ
diff --git a/docs/oomLogoV2-Scale.png b/docs/images/oom_logo/oomLogoV2-Scale.png
similarity index 100%
rename from docs/oomLogoV2-Scale.png
rename to docs/images/oom_logo/oomLogoV2-Scale.png
Binary files differ
diff --git a/docs/oomLogoV2-Upgrade.png b/docs/images/oom_logo/oomLogoV2-Upgrade.png
similarity index 100%
rename from docs/oomLogoV2-Upgrade.png
rename to docs/images/oom_logo/oomLogoV2-Upgrade.png
Binary files differ
diff --git a/docs/oomLogoV2-medium.png b/docs/images/oom_logo/oomLogoV2-medium.png
similarity index 100%
rename from docs/oomLogoV2-medium.png
rename to docs/images/oom_logo/oomLogoV2-medium.png
Binary files differ
diff --git a/docs/index.rst b/docs/index.rst
index 89f9474..94a4bf0 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -16,6 +16,6 @@
oom_setup_paas.rst
oom_developer_guide.rst
oom_cloud_setup_guide.rst
- release-notes.rst
+ release_notes/release-notes.rst
oom_setup_kubernetes_rancher.rst
oom_setup_ingress_controller.rst
diff --git a/docs/k8s-topology.jpg b/docs/k8s-topology.jpg
deleted file mode 100644
index eba8e72..0000000
--- a/docs/k8s-topology.jpg
+++ /dev/null
Binary files differ
diff --git a/docs/oom_cloud_setup_guide.rst b/docs/oom_cloud_setup_guide.rst
index 4b3ec92..6906289 100644
--- a/docs/oom_cloud_setup_guide.rst
+++ b/docs/oom_cloud_setup_guide.rst
@@ -15,7 +15,7 @@
.. _Cloud Native Deployment Wiki: https://wiki.onap.org/display/DW/Cloud+Native+Deployment
.. _ONAP Development - 110 pod limit Wiki: https://wiki.onap.org/display/DW/ONAP+Development#ONAPDevelopment-Changemax-podsfromdefault110podlimit
-.. figure:: oomLogoV2-medium.png
+.. figure:: images/oom_logo/oomLogoV2-medium.png
:align: right
.. _cloud-setup-guide-label:
@@ -58,6 +58,7 @@
guilin 1.15.11 2.16.10 1.15.11 18.09.x
honolulu 1.19.9 3.5.2 1.19.9 19.03.x 1.2.0
Istanbul 1.19.11 3.6.3 1.19.11 19.03.x 1.5.4
+ Jakarta 1.22.4 3.6.3 1.22.4 20.10.x 1.5.4
============== =========== ======= ======== ======== ============
Minimum Hardware Configuration
diff --git a/docs/oom_developer_guide.rst b/docs/oom_developer_guide.rst
index 05cdca1..8df8e74 100644
--- a/docs/oom_developer_guide.rst
+++ b/docs/oom_developer_guide.rst
@@ -22,7 +22,7 @@
OOM Developer Guide
###################
-.. figure:: oomLogoV2-medium.png
+.. figure:: images/oom_logo/oomLogoV2-medium.png
:align: right
ONAP consists of a large number of components, each of which are substantial
@@ -687,7 +687,7 @@
.. database PV
.. @enduml
-.. figure:: kubernetes_objects.png
+.. figure:: images/k8s/kubernetes_objects.png
OOM uses these Kubernetes objects as described in the following sections.
@@ -1074,7 +1074,7 @@
------------------------
A preliminary view of the OOM-MSB integration is as follows:
-.. figure:: MSB-OOM-Diagram.png
+.. figure:: images/msb/MSB-OOM-Diagram.png
A message sequence chart of the registration process:
diff --git a/docs/oom_hardcoded_certificates.rst b/docs/oom_hardcoded_certificates.rst
index c4392c7..326cd39 100644
--- a/docs/oom_hardcoded_certificates.rst
+++ b/docs/oom_hardcoded_certificates.rst
@@ -15,4 +15,4 @@
Here's the list of these certificates:
.. csv-table::
- :file: hardcoded_certificates.csv
+ :file: certs/hardcoded_certificates.csv
diff --git a/docs/oom_project_description.rst b/docs/oom_project_description.rst
index f1587b4..b672c48 100644
--- a/docs/oom_project_description.rst
+++ b/docs/oom_project_description.rst
@@ -17,7 +17,7 @@
ensures that ONAP is easily deployable and maintainable throughout its life
cycle while using hardware resources efficiently.
-.. figure:: oomLogoV2-medium.png
+.. figure:: images/oom_logo/oomLogoV2-medium.png
:align: right
In summary OOM provides the following capabilities:
diff --git a/docs/oom_quickstart_guide.rst b/docs/oom_quickstart_guide.rst
index a38c6f4..27d7a06 100644
--- a/docs/oom_quickstart_guide.rst
+++ b/docs/oom_quickstart_guide.rst
@@ -8,7 +8,7 @@
OOM Quick Start Guide
#####################
-.. figure:: oomLogoV2-medium.png
+.. figure:: images/oom_logo/oomLogoV2-medium.png
:align: right
Once a Kubernetes environment is available (follow the instructions in
@@ -166,12 +166,12 @@
Example Keystone v2.0
-.. literalinclude:: example-integration-override.yaml
+.. literalinclude:: yaml/example-integration-override.yaml
:language: yaml
Example Keystone v3 (required for Rocky and later releases)
-.. literalinclude:: example-integration-override-v3.yaml
+.. literalinclude:: yaml/example-integration-override-v3.yaml
:language: yaml
@@ -203,7 +203,7 @@
> helm repo update
> helm search repo onap
-.. literalinclude:: helm-search.txt
+.. literalinclude:: helm/helm-search.txt
.. note::
The setup of the Helm repository is a one time activity. If you make changes
diff --git a/docs/oom_setup_ingress_controller.rst b/docs/oom_setup_ingress_controller.rst
index cb385da..fafe0db 100644
--- a/docs/oom_setup_ingress_controller.rst
+++ b/docs/oom_setup_ingress_controller.rst
@@ -12,7 +12,7 @@
.. _Onboarding and Distributing a Vendor Software Product: https://wiki.onap.org/pages/viewpage.action?pageId=1018474
.. _README.md: https://gerrit.onap.org/r/gitweb?p=oom.git;a=blob;f=kubernetes/README.md
-.. figure:: oomLogoV2-medium.png
+.. figure:: images/oom_logo/oomLogoV2-medium.png
:align: right
.. _oom_setup_ingress_controller:
diff --git a/docs/oom_setup_kubernetes_rancher.rst b/docs/oom_setup_kubernetes_rancher.rst
index 6272f83..767b939 100644
--- a/docs/oom_setup_kubernetes_rancher.rst
+++ b/docs/oom_setup_kubernetes_rancher.rst
@@ -12,7 +12,7 @@
.. _Onboarding and Distributing a Vendor Software Product: https://wiki.onap.org/pages/viewpage.action?pageId=1018474
.. _README.md: https://gerrit.onap.org/r/gitweb?p=oom.git;a=blob;f=kubernetes/README.md
-.. figure:: oomLogoV2-medium.png
+.. figure:: images/oom_logo/oomLogoV2-medium.png
:align: right
.. _onap-on-kubernetes-with-rancher:
@@ -157,10 +157,10 @@
Apply customization script for Control Plane VMs
------------------------------------------------
-Click :download:`openstack-k8s-controlnode.sh <openstack-k8s-controlnode.sh>`
+Click :download:`openstack-k8s-controlnode.sh <shell/openstack-k8s-controlnode.sh>`
to download the script.
-.. literalinclude:: openstack-k8s-controlnode.sh
+.. literalinclude:: shell/openstack-k8s-controlnode.sh
:language: bash
This customization script will:
@@ -229,10 +229,10 @@
Apply customization script for Kubernetes VM(s)
-----------------------------------------------
-Click :download:`openstack-k8s-workernode.sh <openstack-k8s-workernode.sh>` to
+Click :download:`openstack-k8s-workernode.sh <shell/openstack-k8s-workernode.sh>` to
download the script.
-.. literalinclude:: openstack-k8s-workernode.sh
+.. literalinclude:: shell/openstack-k8s-workernode.sh
:language: bash
This customization script will:
@@ -287,10 +287,10 @@
describes a Kubernetes cluster that will be mapped onto the OpenStack VMs
created earlier in this guide.
-Click :download:`cluster.yml <cluster.yml>` to download the
+Click :download:`cluster.yml <yaml/cluster.yml>` to download the
configuration file.
-.. literalinclude:: cluster.yml
+.. literalinclude:: yaml/cluster.yml
:language: yaml
Prepare cluster.yml
@@ -467,10 +467,10 @@
Apply customization script for NFS Server VM
--------------------------------------------
-Click :download:`openstack-nfs-server.sh <openstack-nfs-server.sh>` to download
+Click :download:`openstack-nfs-server.sh <shell/openstack-nfs-server.sh>` to download
the script.
-.. literalinclude:: openstack-nfs-server.sh
+.. literalinclude:: shell/openstack-nfs-server.sh
:language: bash
This customization script will:
@@ -499,15 +499,15 @@
To properly set up an NFS share on Master and Slave nodes, the user can run the
scripts below.
-Click :download:`master_nfs_node.sh <master_nfs_node.sh>` to download the
+Click :download:`master_nfs_node.sh <shell/master_nfs_node.sh>` to download the
script.
-.. literalinclude:: master_nfs_node.sh
+.. literalinclude:: shell/master_nfs_node.sh
:language: bash
-Click :download:`slave_nfs_node.sh <slave_nfs_node.sh>` to download the script.
+Click :download:`slave_nfs_node.sh <shell/slave_nfs_node.sh>` to download the script.
-.. literalinclude:: slave_nfs_node.sh
+.. literalinclude:: shell/slave_nfs_node.sh
:language: bash
The master_nfs_node.sh script runs in the NFS Master node and needs the list of
diff --git a/docs/oom_user_guide.rst b/docs/oom_user_guide.rst
index 10b57dc..0835a93 100644
--- a/docs/oom_user_guide.rst
+++ b/docs/oom_user_guide.rst
@@ -27,7 +27,7 @@
complete description of these commands please refer to the `Helm
Documentation`_.
-.. figure:: oomLogoV2-medium.png
+.. figure:: images/oom_logo/oomLogoV2-medium.png
:align: right
The following sections describe the life-cycle operations:
@@ -41,7 +41,7 @@
impact
- Delete_ - cleanup individual containers or entire deployments
-.. figure:: oomLogoV2-Deploy.png
+.. figure:: images/oom_logo/oomLogoV2-Deploy.png
:align: right
Deploy
@@ -221,7 +221,7 @@
where the pod identifier refers to the auto-generated pod identifier.
-.. figure:: oomLogoV2-Configure.png
+.. figure:: images/oom_logo/oomLogoV2-Configure.png
:align: right
Configure
@@ -321,7 +321,7 @@
> helm deploy local/onap -n onap -f onap/resources/environments/onap-production.yaml --set global.masterPassword=password
-.. include:: environments_onap_demo.yaml
+.. include:: yaml/environments_onap_demo.yaml
:code: yaml
When deploying all of ONAP, the dependencies section of the Chart.yaml file
@@ -464,7 +464,7 @@
you can grab this public IP directly (as compared to trying to find the
floating IP first) and map this IP in /etc/hosts.
-.. figure:: oomLogoV2-Monitor.png
+.. figure:: images/oom_logo/oomLogoV2-Monitor.png
:align: right
Monitor
@@ -493,7 +493,7 @@
view the current health status of all of the ONAP components for which agents
have been created - a sample from the ONAP Integration labs follows:
-.. figure:: consulHealth.png
+.. figure:: images/consul/consulHealth.png
:align: center
To see the real-time health of a deployment go to: ``http://<kubernetes IP>:30270/ui/``
@@ -503,7 +503,7 @@
If Consul GUI is not accessible, you can refer this
`kubectl port-forward <https://kubernetes.io/docs/tasks/access-application-cluster/port-forward-access-application-cluster/>`_ method to access an application
-.. figure:: oomLogoV2-Heal.png
+.. figure:: images/oom_logo/oomLogoV2-Heal.png
:align: right
Heal
@@ -532,7 +532,7 @@
> kubectl get pods --all-namespaces -o=wide
-.. figure:: oomLogoV2-Scale.png
+.. figure:: images/oom_logo/oomLogoV2-Scale.png
:align: right
Scale
@@ -626,7 +626,7 @@
of how these capabilities can be used is described in the Running Consul on
Kubernetes tutorial.
-.. figure:: oomLogoV2-Upgrade.png
+.. figure:: images/oom_logo/oomLogoV2-Upgrade.png
:align: right
Upgrade
@@ -756,7 +756,7 @@
The previous so pod will be terminated and a new so pod with an updated so
container will be created.
-.. figure:: oomLogoV2-Delete.png
+.. figure:: images/oom_logo/oomLogoV2-Delete.png
:align: right
Delete
diff --git a/docs/otherwise_select_INFRASTRUCTURE_Hosts_and_click_on_Add_Host.jpg b/docs/otherwise_select_INFRASTRUCTURE_Hosts_and_click_on_Add_Host.jpg
deleted file mode 100644
index 18af758..0000000
--- a/docs/otherwise_select_INFRASTRUCTURE_Hosts_and_click_on_Add_Host.jpg
+++ /dev/null
Binary files differ
diff --git a/docs/release-notes-amsterdam.rst b/docs/release_notes/release-notes-amsterdam.rst
similarity index 100%
rename from docs/release-notes-amsterdam.rst
rename to docs/release_notes/release-notes-amsterdam.rst
diff --git a/docs/release-notes-beijing.rst b/docs/release_notes/release-notes-beijing.rst
similarity index 100%
rename from docs/release-notes-beijing.rst
rename to docs/release_notes/release-notes-beijing.rst
diff --git a/docs/release-notes-casablanca.rst b/docs/release_notes/release-notes-casablanca.rst
similarity index 100%
rename from docs/release-notes-casablanca.rst
rename to docs/release_notes/release-notes-casablanca.rst
diff --git a/docs/release-notes-dublin.rst b/docs/release_notes/release-notes-dublin.rst
similarity index 100%
rename from docs/release-notes-dublin.rst
rename to docs/release_notes/release-notes-dublin.rst
diff --git a/docs/release-notes-elalto.rst b/docs/release_notes/release-notes-elalto.rst
similarity index 100%
rename from docs/release-notes-elalto.rst
rename to docs/release_notes/release-notes-elalto.rst
diff --git a/docs/release-notes-frankfurt.rst b/docs/release_notes/release-notes-frankfurt.rst
similarity index 92%
rename from docs/release-notes-frankfurt.rst
rename to docs/release_notes/release-notes-frankfurt.rst
index 7bd4474..8b07f4a 100644
--- a/docs/release-notes-frankfurt.rst
+++ b/docs/release_notes/release-notes-frankfurt.rst
@@ -96,17 +96,17 @@
OOM provides `Helm charts <https://git.onap.org/oom/>`_ that needs to be
"compiled" into Helm package. see step 6 in
-:doc:`quickstart guide <oom_quickstart_guide>`.
+:doc:`quickstart guide <../oom_quickstart_guide>`.
Documentation Deliverables
~~~~~~~~~~~~~~~~~~~~~~~~~~
-- :doc:`Project Description <oom_project_description>`
-- :doc:`Cloud Setup Guide <oom_cloud_setup_guide>`
-- :doc:`Quick Start Guide <oom_quickstart_guide>`
-- :doc:`Setup Ingress Controller <oom_setup_ingress_controller>`
-- :doc:`Developer Guide <oom_developer_guide>`
-- :doc:`Hardcoded Certificates <oom_hardcoded_certificates>`
+- :doc:`Project Description <../oom_project_description>`
+- :doc:`Cloud Setup Guide <../oom_cloud_setup_guide>`
+- :doc:`Quick Start Guide <../oom_quickstart_guide>`
+- :doc:`Setup Ingress Controller <../oom_setup_ingress_controller>`
+- :doc:`Developer Guide <../oom_developer_guide>`
+- :doc:`Hardcoded Certificates <../oom_hardcoded_certificates>`
Known Limitations, Issues and Workarounds
=========================================
@@ -116,7 +116,7 @@
- Hard coded password used for all OOM deployments
[`OJSI-188 <https://jira.onap.org/browse/OJSI-188>`_]
-- :doc:`Hard coded certificates <oom_hardcoded_certificates>` in Helm packages
+- :doc:`Hard coded certificates <../oom_hardcoded_certificates>` in Helm packages
Workarounds
-----------
diff --git a/docs/release-notes-guilin.rst b/docs/release_notes/release-notes-guilin.rst
similarity index 90%
rename from docs/release-notes-guilin.rst
rename to docs/release_notes/release-notes-guilin.rst
index e0af8f7..8d4b432 100644
--- a/docs/release-notes-guilin.rst
+++ b/docs/release_notes/release-notes-guilin.rst
@@ -92,17 +92,17 @@
OOM provides `Helm charts <https://git.onap.org/oom/>`_ that needs to be
"compiled" into Helm package. see step 6 in
-:doc:`quickstart guide <oom_quickstart_guide>`.
+:doc:`quickstart guide <../oom_quickstart_guide>`.
Documentation Deliverables
~~~~~~~~~~~~~~~~~~~~~~~~~~
-- :doc:`Project Description <oom_project_description>`
-- :doc:`Cloud Setup Guide <oom_cloud_setup_guide>`
-- :doc:`Quick Start Guide <oom_quickstart_guide>`
-- :doc:`Setup Ingress Controller <oom_setup_ingress_controller>`
-- :doc:`Developer Guide <oom_developer_guide>`
-- :doc:`Hardcoded Certificates <oom_hardcoded_certificates>`
+- :doc:`Project Description <../oom_project_description>`
+- :doc:`Cloud Setup Guide <../oom_cloud_setup_guide>`
+- :doc:`Quick Start Guide <../oom_quickstart_guide>`
+- :doc:`Setup Ingress Controller <../oom_setup_ingress_controller>`
+- :doc:`Developer Guide <../oom_developer_guide>`
+- :doc:`Hardcoded Certificates <../oom_hardcoded_certificates>`
Known Limitations, Issues and Workarounds
=========================================
@@ -112,7 +112,7 @@
- Hard coded password used for all OOM deployments
[`OJSI-188 <https://jira.onap.org/browse/OJSI-188>`_]
-- :doc:`Hard coded certificates <oom_hardcoded_certificates>` in Helm packages
+- :doc:`Hard coded certificates <../oom_hardcoded_certificates>` in Helm packages
Workarounds
-----------
diff --git a/docs/release-notes-honolulu.rst b/docs/release_notes/release-notes-honolulu.rst
similarity index 91%
rename from docs/release-notes-honolulu.rst
rename to docs/release_notes/release-notes-honolulu.rst
index 59f40ec..bf91a44 100644
--- a/docs/release-notes-honolulu.rst
+++ b/docs/release_notes/release-notes-honolulu.rst
@@ -110,17 +110,17 @@
OOM provides `Helm charts <https://git.onap.org/oom/>`_ that needs to be
"compiled" into Helm package. see step 6 in
-:doc:`quickstart guide <oom_quickstart_guide>`.
+:doc:`quickstart guide <../oom_quickstart_guide>`.
Documentation Deliverables
~~~~~~~~~~~~~~~~~~~~~~~~~~
-- :doc:`Project Description <oom_project_description>`
-- :doc:`Cloud Setup Guide <oom_cloud_setup_guide>`
-- :doc:`Quick Start Guide <oom_quickstart_guide>`
-- :doc:`Setup Ingress Controller <oom_setup_ingress_controller>`
-- :doc:`Developer Guide <oom_developer_guide>`
-- :doc:`Hardcoded Certificates <oom_hardcoded_certificates>`
+- :doc:`Project Description <../oom_project_description>`
+- :doc:`Cloud Setup Guide <../oom_cloud_setup_guide>`
+- :doc:`Quick Start Guide <../oom_quickstart_guide>`
+- :doc:`Setup Ingress Controller <../oom_setup_ingress_controller>`
+- :doc:`Developer Guide <../oom_developer_guide>`
+- :doc:`Hardcoded Certificates <../oom_hardcoded_certificates>`
Known Limitations, Issues and Workarounds
=========================================
@@ -130,7 +130,7 @@
- Hard coded password used for all OOM deployments
[`OJSI-188 <https://jira.onap.org/browse/OJSI-188>`_]
-- :doc:`Hard coded certificates <oom_hardcoded_certificates>` in Helm packages
+- :doc:`Hard coded certificates <../oom_hardcoded_certificates>` in Helm packages
Workarounds
-----------
diff --git a/docs/release-notes.rst b/docs/release_notes/release-notes-isntanbul.rst
similarity index 88%
rename from docs/release-notes.rst
rename to docs/release_notes/release-notes-isntanbul.rst
index bb9c2e8..bd32011 100644
--- a/docs/release-notes.rst
+++ b/docs/release_notes/release-notes-isntanbul.rst
@@ -2,7 +2,9 @@
International License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) ONAP Project and its contributors
-.. _release_notes:
+.. _release_notes_istanbul:
+
+:orphan:
*************************************
ONAP Operations Manager Release Notes
@@ -68,17 +70,17 @@
OOM provides `Helm charts <https://git.onap.org/oom/>`_ that needs to be
"compiled" into Helm package. see step 6 in
-:doc:`quickstart guide <oom_quickstart_guide>`.
+:doc:`quickstart guide <../oom_quickstart_guide>`.
Documentation Deliverables
~~~~~~~~~~~~~~~~~~~~~~~~~~
-- :doc:`Project Description <oom_project_description>`
-- :doc:`Cloud Setup Guide <oom_cloud_setup_guide>`
-- :doc:`Quick Start Guide <oom_quickstart_guide>`
-- :doc:`Setup Ingress Controller <oom_setup_ingress_controller>`
-- :doc:`Developer Guide <oom_developer_guide>`
-- :doc:`Hardcoded Certificates <oom_hardcoded_certificates>`
+- :doc:`Project Description <../oom_project_description>`
+- :doc:`Cloud Setup Guide <../oom_cloud_setup_guide>`
+- :doc:`Quick Start Guide <../oom_quickstart_guide>`
+- :doc:`Setup Ingress Controller <../oom_setup_ingress_controller>`
+- :doc:`Developer Guide <../oom_developer_guide>`
+- :doc:`Hardcoded Certificates <../oom_hardcoded_certificates>`
Known Limitations, Issues and Workarounds
=========================================
diff --git a/docs/release-notes.rst b/docs/release_notes/release-notes.rst
similarity index 83%
copy from docs/release-notes.rst
copy to docs/release_notes/release-notes.rst
index bb9c2e8..a883181 100644
--- a/docs/release-notes.rst
+++ b/docs/release_notes/release-notes.rst
@@ -11,6 +11,7 @@
Previous Release Notes
======================
+- :ref:`Istanbul <release_notes_istanbul>`
- :ref:`Honolulu <release_notes_honolulu>`
- :ref:`Guilin <release_notes_guilin>`
- :ref:`Frankfurt <release_notes_frankfurt>`
@@ -23,7 +24,7 @@
Abstract
========
-This document provides the release notes for the Istanbul release.
+This document provides the release notes for the Jakarta release.
Summary
=======
@@ -40,7 +41,7 @@
| **Docker images** | N/A |
| | |
+--------------------------------------+--------------------------------------+
-| **Release designation** | Istanbul |
+| **Release designation** | Jakarta |
| | |
+--------------------------------------+--------------------------------------+
| **Release date** | |
@@ -54,7 +55,7 @@
**Bug fixes**
A list of issues resolved in this release can be found here:
-https://jira.onap.org/projects/OOM/versions/11074
+
**Known Issues**
@@ -68,17 +69,17 @@
OOM provides `Helm charts <https://git.onap.org/oom/>`_ that needs to be
"compiled" into Helm package. see step 6 in
-:doc:`quickstart guide <oom_quickstart_guide>`.
+:doc:`quickstart guide <../oom_quickstart_guide>`.
Documentation Deliverables
~~~~~~~~~~~~~~~~~~~~~~~~~~
-- :doc:`Project Description <oom_project_description>`
-- :doc:`Cloud Setup Guide <oom_cloud_setup_guide>`
-- :doc:`Quick Start Guide <oom_quickstart_guide>`
-- :doc:`Setup Ingress Controller <oom_setup_ingress_controller>`
-- :doc:`Developer Guide <oom_developer_guide>`
-- :doc:`Hardcoded Certificates <oom_hardcoded_certificates>`
+- :doc:`Project Description <../oom_project_description>`
+- :doc:`Cloud Setup Guide <../oom_cloud_setup_guide>`
+- :doc:`Quick Start Guide <../oom_quickstart_guide>`
+- :doc:`Setup Ingress Controller <../oom_setup_ingress_controller>`
+- :doc:`Developer Guide <../oom_developer_guide>`
+- :doc:`Hardcoded Certificates <../oom_hardcoded_certificates>`
Known Limitations, Issues and Workarounds
=========================================
@@ -92,7 +93,7 @@
- `OOM-2754 <https://jira.onap.org/browse/OOM-2754>`_
Because of *updateEndpoint* property added to *cmpv2issuer* CRD
- it is impossible to upgrade platform component from Honolulu to Istanbul
+ it is impossible to upgrade platform component from Istanbul to Jakarta
release without manual steps. Actions that should be performed:
#. Update the CRD definition::
diff --git a/docs/master_nfs_node.sh b/docs/shell/master_nfs_node.sh
similarity index 100%
rename from docs/master_nfs_node.sh
rename to docs/shell/master_nfs_node.sh
diff --git a/docs/openstack-k8s-controlnode.sh b/docs/shell/openstack-k8s-controlnode.sh
similarity index 100%
rename from docs/openstack-k8s-controlnode.sh
rename to docs/shell/openstack-k8s-controlnode.sh
diff --git a/docs/openstack-k8s-workernode.sh b/docs/shell/openstack-k8s-workernode.sh
similarity index 100%
rename from docs/openstack-k8s-workernode.sh
rename to docs/shell/openstack-k8s-workernode.sh
diff --git a/docs/openstack-nfs-server.sh b/docs/shell/openstack-nfs-server.sh
similarity index 100%
rename from docs/openstack-nfs-server.sh
rename to docs/shell/openstack-nfs-server.sh
diff --git a/docs/slave_nfs_node.sh b/docs/shell/slave_nfs_node.sh
similarity index 100%
rename from docs/slave_nfs_node.sh
rename to docs/shell/slave_nfs_node.sh
diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
deleted file mode 100644
index 5140ec2..0000000
--- a/docs/spelling_wordlist.txt
+++ /dev/null
@@ -1,461 +0,0 @@
-AAF
-AAI
-ACL
-adaptor
-Adaptor
-adaptors
-Adaptors
-Alcatel
-Ansible
-API
-APIs
-APPC
-ASCII
-Avro
-BPMN
-Camunda
-Cask
-Cassandra
-CCSDK
-CD
-CDAP
-Ceilometer
-CentOS
-CI
-CLI
-Cloudify
-Codec
-committer
-committers
-CommonMark
-Contrail
-CPU
-CRM
-CSCF
-CSIT
-cyber
-DBaaS
-DCAE
-DevOps
-DHCP
-Django
-DMaaP
-DNS
-DNSaaS
-DPDK
-Ebook
-elasticsearch
-Elasticsearch
-Enablement
-enum
-Enum
-env
-Env
-ENV
-ethernet
-Facebook
-failover
-fallback
-Fcaps
-Financials
-geocoder
-Gerrit
-Git
-Github
-graphSON
-guestOS
-gui
-Hadoop
-hardcoded
-hashtag
-healthcheck
-healthCheck
-Healthcheck
-HealthCheck
-healthchecks
-heatbridge
-heatclient
-HeatStack
-hostname
-hostName
-Hostname
-hostnames
-hostOS
-htm
-html
-http
-Http
-httpclient
-httpcomponents
-httpdomain
-httpHeader
-httpPort
-httpreturncode
-https
-httpStatusCode
-Huawei
-hyperlink
-Hyperlink
-hypervisor
-Hypervisor
-hypervisors
-Hypervisors
-IaaS
-indices
-Indices
-inline
-internet
-interoperable
-interoperate
-Interoperate
-interoperation
-interwork
-Interworking
-IoT
-ip
-Ip
-IP
-ipAddress
-iPAddress
-IPAddress
-ipam
-Ipam
-ipVersion
-Jacoco
-java
-javalib
-javascript
-Javascript
-jboss
-JBoss
-Jenkins
-Jira
-jpath
-json
-Json
-jsonObject
-jsonObjectInstance
-jsonObjects
-jsonschema
-jtosca
-junit
-Junit
-JUnit
-Junits
-JUnits
-Karaf
-keypair
-Keypair
-keypairs
-keyserver
-keyservers
-keyspace
-Keyspace
-keyspaceName
-keyspaces
-keystore
-keytool
-keyValue
-Kibana
-Kibibytes
-kubectl
-Kubernetes
-LF
-lifecycle
-Lifecycle
-lifecycles
-locator
-logback
-Logback
-logfiles
-Logfiles
-logoffs
-Logoffs
-logon
-Logstash
-macAddress
-MacAddress
-macOS
-Malware
-MariaDB
-metadata
-Metadata
-microservice
-Microservice
-microservices
-Microservices
-middleware
-msb
-MSB
-multicast
-multicloud
-Multicloud
-MultiCloud
-multipart
-Mysql
-NaaS
-nameserver
-nameservers
-namespace
-Namespace
-namespaced
-namespaces
-Namespaces
-Netconf
-nfv
-NFV
-nfvi
-nfvo
-nfvparser
-Nokia
-NSD
-OAM
-Ocata
-ODL
-Onap
-ONAP
-onboard
-Onboard
-onboarded
-Onboarded
-onboarding
-Onboarding
-online
-OOF
-oom
-OOM
-OpenDaylight
-OpenFlow
-openo
-OpenO
-Opensource
-Openstack
-OpenStack
-OSS
-ovs
-ovsdb
-Pandoc
-partitionKey
-Partitionkey
-passphrase
-PCRF
-pdf
-PGaaS
-Phishing
-PKI
-placemark
-Placemark
-placemarks
-plantUML
-playbook
-Playbook
-playbooks
-Playbooks
-plugin
-Plugin
-plugins
-Plugins
-PNF
-PoC
-Postgre
-Postgres
-Postgresql
-preload
-Preload
-proactively
-programmatically
-proxyhost
-pserver
-pServer
-pservers
-QoS
-quickstart
-Quickstart
-Rackspace
-readme
-readthedocs
-Readthedocs
-Redhat
-Redis
-refactored
-Refactored
-registrator
-Registrator
-releng
-repo
-Repo
-repos
-Restconf
-reStructuredText
-reusability
-Reusability
-RMM
-roadmap
-roadmaps
-RPT
-rst
-RST
-RVMI
-schemas
-screensaver
-sdc
-Sdc
-SDC
-sdk
-SDK
-SDN
-sdnc
-Sdnc
-SDNC
-Selenium
-servlet
-Servlet
-Skynet
-SLI
-SMP
-SNMP
-SPI
-SQL
-stateful
-subclassed
-subclassing
-subdomain
-subflows
-suboperation
-suboperations
-Suboperations
-subtending
-syslog
-sysLog
-Syslog
-syslogs
-Syslogs
-tablename
-taxonomical
-TBD
-Telco
-telecom
-Telecom
-templated
-templating
-timeframe
-timeslots
-timestamp
-Timestamp
-transcoding
-UDP
-UI
-uncheck
-undeploy
-Undeploy
-undeployed
-undeploying
-Undeployment
-uninstall
-uninstallation
-uninstalled
-unitless
-Unregistration
-updatable
-uploadable
-url
-Url
-urls
-usecase
-Usecase
-userid
-username
-Username
-usernames
-validator
-Validator
-vcpu
-vcpus
-vdns
-versioned
-Versioned
-versioning
-Versioning
-vertices
-Vertices
-vf
-vF
-vfc
-vFC
-VFC
-vfcadaptor
-vfirewall
-vFirewall
-vfmodule
-vfModule
-VfModule
-vfModules
-vfstatus
-vfStatus
-virtualization
-Virtualization
-virtualize
-virtualized
-Virtualized
-virtualizes
-virtualizing
-vlan
-Vld
-vm
-Vm
-VM
-vms
-VMs
-VMware
-vnf
-vNF
-Vnf
-VNF
-vnfapi
-vnfc
-VNFFG
-vnfm
-Vnfm
-VNFM
-VNFMs
-vnfs
-vNFs
-vnfsdk
-VPN
-vrouter
-vserver
-vServer
-Vserver
-vservers
-Vservers
-vswitch
-VVP
-Vyatta
-webapp
-webapps
-Webpage
-webserver
-WebServer
-Websocket
-Websockets
-whitebox
-whiteboxes
-whitepaper
-wiki
-Wiki
-Wikis
-Wildfly
-Windriver
-Wireline
-workflow
-Workflow
-workflows
-www
-xml
-Xmx
-Yaml
-yamls
-zabbix
-Zachman
-Zookeeper
-ZTE
diff --git a/docs/cluster.yml b/docs/yaml/cluster.yml
similarity index 100%
rename from docs/cluster.yml
rename to docs/yaml/cluster.yml
diff --git a/docs/environments_onap_demo.yaml b/docs/yaml/environments_onap_demo.yaml
similarity index 100%
rename from docs/environments_onap_demo.yaml
rename to docs/yaml/environments_onap_demo.yaml
diff --git a/docs/example-integration-override-v3.yaml b/docs/yaml/example-integration-override-v3.yaml
similarity index 100%
rename from docs/example-integration-override-v3.yaml
rename to docs/yaml/example-integration-override-v3.yaml
diff --git a/docs/example-integration-override.yaml b/docs/yaml/example-integration-override.yaml
similarity index 100%
rename from docs/example-integration-override.yaml
rename to docs/yaml/example-integration-override.yaml
