Add installation script

[nonrtric/plt/rappmanager.git] / scripts / install / README.md

diff --git a/scripts/install/README.md b/scripts/install/README.md
new file mode 100755 (executable)
index 0000000..5f7f3bf
--- /dev/null
+++ b/scripts/install/README.md
@@ -0,0 +1,40 @@
+## Installation of Rapp Manager
+
+Rapp Manager application requires the following components,
+
+* ONAP ACM
+* OSC SME
+
+
+### Pre-requisites
+
+The installation scripts do not handle the required installations listed below.
+
+* Kubernetes cluster(v1.24.6)
+* GIT
+
+### Installation
+
+All the components can be installed as shown below,
+```
+./install-all.sh
+```
+
+Individual components can be installed using the commands below,
+
+```./install-base.sh``` - Installs the tools required for other installer scripts.
+
+```./install-acm.sh``` - Installs the ACM, and it's related components.
+
+```./install-kserve.sh``` - Installs the Kserve, and it's related components.
+
+```./install-nonrtric.sh``` - Installs the NONRTRIC components.
+
+> **These scripts are specifically designed for a fresh environment.**
+
+### Uninstallation
+
+```./uninstall-all.sh``` - Uninstalls all the components
+
+
+