summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/bare_metal_provisioning.rst2
-rw-r--r--docs/controllers.yaml161
-rw-r--r--docs/kud_architecture.rst8
3 files changed, 166 insertions, 5 deletions
diff --git a/docs/bare_metal_provisioning.rst b/docs/bare_metal_provisioning.rst
index 885ffea3..4a7029b6 100644
--- a/docs/bare_metal_provisioning.rst
+++ b/docs/bare_metal_provisioning.rst
@@ -122,7 +122,7 @@ Nested-Virtualization.
**Deploying KUD services**
-Finally, the KRD provisioning process can be started through the use of
+Finally, the KUD provisioning process can be started through the use of
*installer.sh* bash script. The output of this script is collected in the
*kud_installer.log* file for future reference.
diff --git a/docs/controllers.yaml b/docs/controllers.yaml
new file mode 100644
index 00000000..9d266846
--- /dev/null
+++ b/docs/controllers.yaml
@@ -0,0 +1,161 @@
+# Copyright 2020 Intel Corporation.
+# 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.
+
+openapi: 3.0.1
+info:
+ title: ONAP4K8S Orchestrator Controller Register API
+ description: 'This is the Orchestrator Controller gRPC Register API. Find out more about the Orchestrator at: https://wiki.onap.org/display/DW/Multi+Cluster+Application+Scheduler'
+ contact:
+ name: Marcus Williams
+ email: marcus.williams@intel.com
+ license:
+ name: Apache 2.0
+ url: http://www.apache.org/licenses/LICENSE-2.0.html
+ version: 0.0.1
+externalDocs:
+ description: ONAP4K8S Orchestrator Controller Register API
+ url: 'https://wiki.onap.org/display/DW/V2+API+Specification#V2APISpecification-OrchestratorControllerRegistrationAPI'
+servers:
+- url: http://127.0.0.1:9015
+tags:
+- name: controllers
+
+paths:
+ /v2/controllers:
+ post:
+ tags:
+ - controllers
+ summary: Add a new controller to the orchestrator
+ operationId: addController
+ requestBody:
+ description: Describe new controller to add to the orchestrator
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Controller'
+ required: true
+ responses:
+ 405:
+ description: Invalid input
+ content: {}
+ security:
+ - OAuth2: []
+ - OpenId: []
+ - BasicHTTP: []
+ x-codegen-request-body-name: body
+ put:
+ tags:
+ - controllers
+ summary: Add a new controller to the orchestrator
+ operationId: putController
+ requestBody:
+ description: Describe new controller to add to the orchestrator
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Controller'
+ required: true
+ responses:
+ 405:
+ description: Validation exception
+ content: {}
+ security:
+ - OAuth2: []
+ - OpenId: []
+ - BasicHTTP: []
+ x-codegen-request-body-name: body
+ /v2/controllers/{controller-name}:
+ get:
+ tags:
+ - controllers
+ summary: Find controller by name
+ description: Returns a controller
+ operationId: getController
+ parameters:
+ - name: controller-name
+ in: path
+ description: Name of controller
+ required: true
+ schema:
+ type: string
+ responses:
+ 200:
+ description: successful operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Controller'
+ 400:
+ description: Invalid controller-name supplied
+ content: {}
+ 404:
+ description: Controller not found
+ content: {}
+ security:
+ - OAuth2: []
+ - OpenId: []
+ - BasicHTTP: []
+ delete:
+ tags:
+ - controllers
+ summary: Deletes a controller
+ operationId: deleteController
+ parameters:
+ - name: controller-name
+ in: path
+ description: service name
+ required: true
+ schema:
+ type: string
+ responses:
+ 400:
+ description: Invalid controller name supplied
+ content: {}
+ 404:
+ description: Controller not found
+ content: {}
+ security:
+ - OAuth2: []
+ - OpenId: []
+ - BasicHTTP: []
+components:
+ schemas:
+ Controller:
+ type: object
+ required:
+ - name
+ - host
+ - port
+ properties:
+ name:
+ type: string
+ host:
+ type: string
+ port:
+ type: integer
+ format: int64
+ example:
+ name: HPA-Placement-Controller
+ host: 10.7.100.4
+ port: 8800
+ securitySchemes:
+ OAuth2:
+ type: oauth2
+ flows:
+ authorizationCode:
+ authorizationUrl: /oauth/authorize
+ tokenUrl: /oauth/token
+ OpenId:
+ type: openIdConnect
+ openIdConnectUrl: https://example.com/.well-known/openid-configuration
+ BasicHTTP:
+ type: http
+ scheme: basic
diff --git a/docs/kud_architecture.rst b/docs/kud_architecture.rst
index f56b72a5..2f724410 100644
--- a/docs/kud_architecture.rst
+++ b/docs/kud_architecture.rst
@@ -17,8 +17,8 @@ This document explains the different components of the Kubernetes
Reference Deployment project and how they can be configured to modify
its default behaviour.
-Vagranfile
-##########
+Vagrantfile
+###########
This file describes how the Virtual Machines are going to be
configured and the scripts and arguments used during their
@@ -127,7 +127,7 @@ setup.sh
########
This bash script is used for the installation and configuration of
-dependencies required for the usage of the KRD via Virtual Machines.
+dependencies required for the usage of the KUD via Virtual Machines.
Some of this dependencies are:
- `Vagrant <https://www.vagrantup.com/>`_,
@@ -138,7 +138,7 @@ and installed in the host machine.
.. code-block:: bash
- ./setup.sh -p libvirt
+ sudo ./setup.sh -p libvirt
Vagrant uses VirtualBox as default Virtualization provider. It's
possible to modify this behavior using the global enviroment variable