NONRTRIC-924: RANPM - Add control-panel to Kubernetes deployment

[nonrtric/plt/ranpm.git] / install / README.md

diff --git a/install/README.md b/install/README.md
index 3d616a8..2b707c1 100644 (file)
--- a/install/README.md
+++ b/install/README.md
@@ -1,4 +1,17 @@
+## License
+
+Copyright (C) 2023 Nordix Foundation. All rights reserved.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
 
+     http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 ## Prerequisites
 
@@ -8,7 +21,7 @@ The ranpm setup works on linux/MacOS or on windows via WSL using a local or remo
 - kubernetes cluster
 - local docker for building images
 
-It is recommended to run the ranpm on a kubernetes cluster instead of local docker-desktop etc as the setup requires a fair amount of computer resouces.
+It is recommended to run the ranpm on a kubernetes cluster instead of local docker-desktop etc as the setup requires a fair amount of computer resources.
 
 # Requirement on kubernetes
 
@@ -16,21 +29,23 @@ The demo set can be run on local or remote kubernetes.
 Kubectl must be configured to point to the applicable kubernetes instance.
 Nodeports exposed by the kubernetes instance must be accessible by the local machine - basically the kubernetes control plane IP needs to be accessible from the local machine.
 
-- Latest version of istio install
+- Latest version of istio installed
 
 # Other requirements
 - helm3
 - bash
 - cmd 'envsubst' must be installed (check by cmd: 'type envsubst' )
 - cmd 'jq' must be installed (check by cmd: 'type jq' )
+- keytool
+- openssl
+
 
 ## Before installation
 The following images need to be built manually. If remote or multi node cluster is used, then an image repo needs to be available to push the built images to.
-If external repo is used, use the same repo for all built images and configure the reponame in `helm/global-values.yaml` (the parameter value of extimagerepo shall have a trailing `/`)
+If external repo is used, use the same repo for all built images and configure the reponame in `helm/global-values.yaml`
 
 Build the following images (build instruction in each dir)
 - ranpm/https-server
-- ranpm/pm-file-converter
 - pm-rapp
 
 
@@ -46,12 +61,12 @@ The following scripts are provided for installing (install-nrt.sh mush be instal
 - install-pm-influx-job.sh : Sets up an alternative job to produce data stored in influx db.
 - install-pm-rapp.sh : Installs a rapp that subscribe and print out received data
 
-## Unstallation
+## Uninstallation
 
 There is a corresponding uninstall script for each install script. However, it is enough to just run `uninstall-nrt.sh` and `uninstall-pm-rapp.sh´.
 
 ## Exposed ports to APIs
-All exposed APIs on individual port numbers (nodeporta) on the address of the kubernetes control plane.
+All exposed APIs on individual port numbers (nodeports) on the address of the kubernetes control plane.
 
 ### Keycloak API
 Keycloak API accessed via proxy (proxy is needed to make keycloak issue token with the internal address of keycloak).
@@ -95,18 +110,7 @@ Browser for influx db.
 - user: admin
 - password: mySuP3rS3cr3tT0keN
 
-
-## License
-
-Copyright (C) 2023 Nordix Foundation. All rights reserved.
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-     http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+### Controlpanel
+Browser for control-panel \
+browser: `<host ip>:30091/ei-coordinator`
+- nodeport: 30091