This patch adds the README files 90/190/1
authorZhe Huang <zhehuang@research.att.com>
Thu, 23 May 2019 20:08:00 +0000 (16:08 -0400)
committerZhe Huang <zhehuang@research.att.com>
Thu, 23 May 2019 20:08:00 +0000 (16:08 -0400)
Signed-off-by: Zhe Huang <zhehuang@research.att.com>
Change-Id: I8356dedf61795d9c140db05d45de2fe2bc609b6e

22 files changed:
LICENSES.txt [new file with mode: 0644]
README.md [new file with mode: 0644]
aux/80-Auxiliary-Functions/bin/uninstall [new file with mode: 0755]
aux/80-Auxiliary-Functions/helm/dashboard/charts/common-1.1.0.tgz [deleted file]
aux/README.md [new file with mode: 0644]
infra/10-Nexus/docker/Dockerfile
infra/10-Nexus/helm/charts/common-1.1.0.tgz [deleted file]
infra/10-Nexus/helm/templates/_helpers.tpl
infra/10-Nexus/helm/templates/deployment.yaml
infra/10-Nexus/helm/templates/ingress.yaml
infra/10-Nexus/helm/templates/save-secret-job.yaml
infra/10-Nexus/helm/templates/secret-docker.yaml
infra/10-Nexus/helm/templates/service.yaml
infra/10-Nexus/helm/values.yaml
infra/README.md [new file with mode: 0644]
ric-platform/50-RIC-Platform/helm/appmgr/charts/common-1.1.0.tgz [deleted file]
ric-platform/50-RIC-Platform/helm/dbaas/charts/common-1.1.0.tgz [deleted file]
ric-platform/50-RIC-Platform/helm/e2mgr/charts/common-1.1.0.tgz [deleted file]
ric-platform/50-RIC-Platform/helm/e2term/charts/common-1.1.0.tgz [deleted file]
ric-platform/50-RIC-Platform/helm/rtmgr/charts/common-1.1.0.tgz [deleted file]
ric-platform/README.md [new file with mode: 0644]
xapps/README.md [new file with mode: 0644]

diff --git a/LICENSES.txt b/LICENSES.txt
new file mode 100644 (file)
index 0000000..2a3dd5c
--- /dev/null
@@ -0,0 +1,32 @@
+LICENSES.txt
+
+
+Unless otherwise specified, all software contained herein is licensed
+under the Apache License, Version 2.0 (the "Software License");
+you may not use this software except in compliance with the Software
+License. You may obtain a copy of the Software License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the Software License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the Software License for the specific language governing permissions
+and limitations under the Software License.
+
+
+
+Unless otherwise specified, all documentation contained herein is licensed
+under the Creative Commons License, Attribution 4.0 Intl. (the
+"Documentation License"); you may not use this documentation except in
+compliance with the Documentation License. You may obtain a copy of the
+Documentation License at
+
+https://creativecommons.org/licenses/by/4.0/
+
+Unless required by applicable law or agreed to in writing, documentation
+distributed under the Documentation License is distributed on an "AS IS"
+BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied. See the Documentation License for the specific language governing
+permissions and limitations under the Documentation License.
+
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..3987ce6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+# RIC Integration
+  
+This repo contains RAN Intelligent Controller (RIC) deployments related files.
+
+### Directory Structure
+.
+├── aux                  Deployment scripts, charts and configuration files for RIC auxiliry functions
+├── infra                Deployment scripts, charts and configuration files for infrastructure support
+├── LICENSES.txt         License information
+├── README.md            This file
+├── ric-platform         Deployment scripts, charts and configuration files for RIC platform components
+└── xapps                xApp related scripts, charts and configuration files
+
+### Directory Naming Convention
+
+The root directories are orgainzed according to the deployment plans. Each directory contains subdirectories for
+different deployable components. The prefix of these subdirectories represents the deployment order. The smaller the
+prefix number the eariler the corresponding component will be deployed.  Consider the following example,
+.
+├── aux
+│   └── 80-Auxiliary-Functions
+├── infra
+│   ├── 00-Kubernetes
+│   └── 10-Nexus
+├── LICENSES.txt
+├── README.md
+├── ric-platform
+│   ├── 20-Credential
+│   └── 50-RIC-Platform
+└── xapps
+    └── 90-xApps
+when deploys the ric-platform, the credential is deployed before RIC-Platform.
+
+In each of the component directory, ./etc contains the configuration file, ./bin contains the binary and script files,
+./helm contains the helm charts, and ./docker contains docker related files for building the docker images. Please refer
+to the README.md files in individual directory for more details.
+
+### To deploy RIC
+TBD will update when we have the root installer.
+
+### Configure the RIC deployment
+TBD will update when we have the root installer.
diff --git a/aux/80-Auxiliary-Functions/bin/uninstall b/aux/80-Auxiliary-Functions/bin/uninstall
new file mode 100755 (executable)
index 0000000..9ab2775
--- /dev/null
@@ -0,0 +1,48 @@
+#!/bin/bash
+################################################################################
+#   Copyright (c) 2019 AT&T Intellectual Property.                             #
+#   Copyright (c) 2019 Nokia.                                                  #
+#                                                                              #
+#   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.                                             #
+################################################################################
+
+
+
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )"
+
+
+source $DIR/../etc/dashboard.conf
+
+if [ -z "$RICAUX_RELEASE_NAME" ];then
+   RELEASE_NAME=$helm_release_name
+else
+   RELEASE_NAME=$RICAUX_RELEASE_NAME
+fi
+if [ -z "$RICAUX_NAMESPACE" ];then
+   NAMESPACE=$namespace
+else
+   NAMESPACE=$RICAUX_NAMESPACE
+fi
+
+RICAUX_COMPONENTS="dashboard"
+
+echo "Undeploying RIC AUX components [$RICAUX_COMPONENTS]"
+echo "Platform Namespace: $NAMESPACE"
+echo "Helm Release Name: $RELEASE_NAME"
+
+
+
+for component in $RICAUX_COMPONENTS; do
+  helm delete --purge  "${RELEASE_NAME}-$component" 
+done
diff --git a/aux/80-Auxiliary-Functions/helm/dashboard/charts/common-1.1.0.tgz b/aux/80-Auxiliary-Functions/helm/dashboard/charts/common-1.1.0.tgz
deleted file mode 100644 (file)
index ccccfe6..0000000
Binary files a/aux/80-Auxiliary-Functions/helm/dashboard/charts/common-1.1.0.tgz and /dev/null differ
diff --git a/aux/README.md b/aux/README.md
new file mode 100644 (file)
index 0000000..34ce2cf
--- /dev/null
@@ -0,0 +1,40 @@
+# RIC Auxiliary Functions
+  
+Helm charts, configuration files, and automation scripts that deploy the auxiliary functions for RIC. The auxiliary
+functions are defined as the features and services that interact with the RIC but they do not collocated with the RIC
+cluster. These functions includes but not limited to non-realtime management components (e.g., dashboard, DMaaP,
+VEScollector) that interact with RIC using A1/O1 interfaces. 
+
+
+
+### Directory Structure
+.
+├── 80-Auxiliary-Functions    Contains components that interact with RIC through A1/O1
+│   ├── bin                   Contains deployment and uninstall scripts
+│   ├── etc                   Contains deployment configuration files
+│   └── helm                  Contains helm charts
+└── README.md                 This file
+
+
+### To deploy the Auxiliary Functions
+```sh
+$ # Modify the configuration files in ./80-Auxiliary-Functions/etc/
+$ . ./80-Auxiliary-Functions/bin/install
+$ # If you have an override value.yaml file, please use
+$ #. ./80-Auxiliary-Functions/bin/install YOUR_OVERRIDE_FILE
+```
+
+
+### To undeploy the Auxiliary Functions
+```sh
+$ . ./80-Auxiliary-Functions/bin/uninstall
+```
+
+
+### Deployment Options
+You can configure the Helm release name, Kubernetes namespace using configuration files located in ./80-Auxiliary-Functions/etc/
+
+In the one-click deployment solution, the above setting will be overrided by environment variables shown below.
+*RICAUX_RELEASE_NAME
+*RICAUX_NAMESPACE
+
index f61b21c..bb9a60e 100644 (file)
@@ -1,3 +1,20 @@
+################################################################################
+#   Copyright (c) 2019 AT&T Intellectual Property.                             #
+#   Copyright (c) 2019 Nokia.                                                  #
+#                                                                              #
+#   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.                                             #
+################################################################################
+
 ARG NEXUS_VERSION=3.15.2
 ARG NEXUS_BUILD=01
 
diff --git a/infra/10-Nexus/helm/charts/common-1.1.0.tgz b/infra/10-Nexus/helm/charts/common-1.1.0.tgz
deleted file mode 100644 (file)
index ccccfe6..0000000
Binary files a/infra/10-Nexus/helm/charts/common-1.1.0.tgz and /dev/null differ
index 9f9800c..fba2b96 100644 (file)
@@ -1,3 +1,20 @@
+################################################################################
+#   Copyright (c) 2019 AT&T Intellectual Property.                             #
+#   Copyright (c) 2019 Nokia.                                                  #
+#                                                                              #
+#   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.                                             #
+################################################################################
+
 {{/* vim: set filetype=mustache: */}}
 {{/*
 Expand the name of the chart.
index d3184c0..65c5c23 100644 (file)
@@ -1,3 +1,20 @@
+################################################################################
+#   Copyright (c) 2019 AT&T Intellectual Property.                             #
+#   Copyright (c) 2019 Nokia.                                                  #
+#                                                                              #
+#   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.                                             #
+################################################################################
+
 apiVersion: apps/v1beta2
 kind: Deployment
 metadata:
index 1a7522a..078f1af 100644 (file)
@@ -1,3 +1,20 @@
+################################################################################
+#   Copyright (c) 2019 AT&T Intellectual Property.                             #
+#   Copyright (c) 2019 Nokia.                                                  #
+#                                                                              #
+#   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.                                             #
+################################################################################
+
 {{- $fullName := include "nexus.fullname" . -}}
 apiVersion: extensions/v1beta1
 kind: Ingress
index 801df24..44b75ef 100644 (file)
@@ -1,3 +1,20 @@
+################################################################################
+#   Copyright (c) 2019 AT&T Intellectual Property.                             #
+#   Copyright (c) 2019 Nokia.                                                  #
+#                                                                              #
+#   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.                                             #
+################################################################################
+
 apiVersion: batch/v1
 kind: Job
 metadata:
index 7365f7e..d113b38 100644 (file)
@@ -1,3 +1,20 @@
+################################################################################
+#   Copyright (c) 2019 AT&T Intellectual Property.                             #
+#   Copyright (c) 2019 Nokia.                                                  #
+#                                                                              #
+#   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.                                             #
+################################################################################
+
 apiVersion: v1
 kind: Secret
 type: kubernetes.io/tls
index cc9b518..796206f 100644 (file)
@@ -1,3 +1,20 @@
+################################################################################
+#   Copyright (c) 2019 AT&T Intellectual Property.                             #
+#   Copyright (c) 2019 Nokia.                                                  #
+#                                                                              #
+#   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.                                             #
+################################################################################
+
 apiVersion: v1
 kind: Service
 metadata:
index d7324f5..b35bd0c 100644 (file)
@@ -1,3 +1,20 @@
+################################################################################
+#   Copyright (c) 2019 AT&T Intellectual Property.                             #
+#   Copyright (c) 2019 Nokia.                                                  #
+#                                                                              #
+#   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.                                             #
+################################################################################
+
 # Default values for nexus.
 # This is a YAML-formatted file.
 # Declare variables to be passed into your templates.
diff --git a/infra/README.md b/infra/README.md
new file mode 100644 (file)
index 0000000..55251a6
--- /dev/null
@@ -0,0 +1,43 @@
+# RIC Infrastructure Support
+  
+Helm charts, configuration files, and automation scripts that deploy a development enviroment for RIC.
+A developer should star from here to create a kubernetes cluster that is pre-configured for RIC.
+Such development cluster is mimicking a closed field-trial environment. 
+
+
+
+### Directory Structure
+.
+├── 00-Kubernetes             Contains scripts to deploy K8S cluster
+├── 10-Nexus                  Contains scripts and helm charts to deploy the docker registry and helm repo
+└── README.md                 This file
+
+
+### To deploy the Kubernetes cluster
+```sh
+$ # Modify the configuration files in ./00-Kubernetes/etc/
+$ . ./00-Kubernetes/bin/install
+```
+
+### To deploy Nexus repo manager
+```sh
+$ # Modify the configuration files in ./10-Nexus/etc/
+$ . ./10-Nexus/bin/install
+```
+
+
+### Nexus Deployment Options
+You can configure the Helm release name, Kubernetes namespace, and specify ingress controller port using configuration
+files located in ./10-Nexus/etc/
+
+In the one-click deployment solution, the above setting will be overrided by environment variables shown below.
+*RICINFRA_RELEASE_NAME
+*RICINFRA_NAMESPACE
+*INGRESS_PORT
+
+
+### Passing credential to RIC
+The installation process of the Nexus repo manager will generate certificates and credential for docker registry and
+helm repo.
+
+TODO: Fill in the details about how to pass the credential to RIC 
diff --git a/ric-platform/50-RIC-Platform/helm/appmgr/charts/common-1.1.0.tgz b/ric-platform/50-RIC-Platform/helm/appmgr/charts/common-1.1.0.tgz
deleted file mode 100644 (file)
index 994e516..0000000
Binary files a/ric-platform/50-RIC-Platform/helm/appmgr/charts/common-1.1.0.tgz and /dev/null differ
diff --git a/ric-platform/50-RIC-Platform/helm/dbaas/charts/common-1.1.0.tgz b/ric-platform/50-RIC-Platform/helm/dbaas/charts/common-1.1.0.tgz
deleted file mode 100644 (file)
index 994e516..0000000
Binary files a/ric-platform/50-RIC-Platform/helm/dbaas/charts/common-1.1.0.tgz and /dev/null differ
diff --git a/ric-platform/50-RIC-Platform/helm/e2mgr/charts/common-1.1.0.tgz b/ric-platform/50-RIC-Platform/helm/e2mgr/charts/common-1.1.0.tgz
deleted file mode 100644 (file)
index 994e516..0000000
Binary files a/ric-platform/50-RIC-Platform/helm/e2mgr/charts/common-1.1.0.tgz and /dev/null differ
diff --git a/ric-platform/50-RIC-Platform/helm/e2term/charts/common-1.1.0.tgz b/ric-platform/50-RIC-Platform/helm/e2term/charts/common-1.1.0.tgz
deleted file mode 100644 (file)
index 994e516..0000000
Binary files a/ric-platform/50-RIC-Platform/helm/e2term/charts/common-1.1.0.tgz and /dev/null differ
diff --git a/ric-platform/50-RIC-Platform/helm/rtmgr/charts/common-1.1.0.tgz b/ric-platform/50-RIC-Platform/helm/rtmgr/charts/common-1.1.0.tgz
deleted file mode 100644 (file)
index 994e516..0000000
Binary files a/ric-platform/50-RIC-Platform/helm/rtmgr/charts/common-1.1.0.tgz and /dev/null differ
diff --git a/ric-platform/README.md b/ric-platform/README.md
new file mode 100644 (file)
index 0000000..6b8f3a0
--- /dev/null
@@ -0,0 +1,47 @@
+# RIC Platform Components
+  
+Helm charts, deployment scripts and configuration files for RIC platform components.
+
+### Directory Structure
+.
+├── 20-Credential        Helm charts to onboard credential and secrets for docker registry and helm repo
+├── 50-RIC-Platform      Deployment scripts, charts and configuration files for RIC platform components
+└── README.md            This file
+
+### To onboard credentials
+```sh
+$ # Modify the user name and password in ./20-Credential/helm/values.yaml
+$ # Alternatively, include the credential information in an override value yaml file
+$ . ./20-Credential/bin/install
+$ # If you have an override value.yaml file, please use
+$ #. ./20-Credential/bin/install YOUR_OVERRIDE_FILE
+```
+
+### Credential Deployment Options
+You can configure the Helm release name, Kubernetes namespace using configuration files located in ./20-Credential/etc/
+Please make sure that the namespace is the same one as the one used for RIC platform components.
+
+In the one-click deployment solution, the above setting will be overrided by environment variables shown below.
+*RICPLT_RELEASE_NAME
+*RICPLT_NAMESPACE
+
+
+### To Deploy RIC Platform
+```sh
+$ # Modify the configuration files in ./50-RIC-Platform/etc/
+$ . ./50-RIC-Platform/bin/install
+$ # If you have an override value.yaml file, please use
+$ #. ./50-RIC-Platform/bin/install YOUR_OVERRIDE_FILE
+```
+
+### RIC Platform Deployment Options
+You can configure the Helm release name, Kubernetes namespace using configuration files located in ./50-RIC-Platform/etc/
+Please make sure that the namespace is the same one as the one used for RIC platform components.
+
+In the one-click deployment solution, the above setting will be overrided by environment variables shown below.
+*RICPLT_RELEASE_NAME
+*RICPLT_NAMESPACE
+
+### To Undeploy RIC Platform
+```sh
+$ . ./50-RIC-Platform/bin/uninstall
diff --git a/xapps/README.md b/xapps/README.md
new file mode 100644 (file)
index 0000000..5fb28ad
--- /dev/null
@@ -0,0 +1,9 @@
+# RIC xApps
+  
+Helm charts for xApps.
+
+### Directory Structure
+.
+├── 90-xApps            Helm charts for xApps
+└── README.md
+