summaryrefslogtreecommitdiffstats
path: root/kubernetes/LICENSE
blob: d1e69ec4973895a316508fc44f717b13a7a4a8a1 (plain) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

 ============LICENSE_START==========================================
 ===================================================================
 Copyright © 2017 Amdocs
 Copyright © 2017 Bell Canada
 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.
 ============LICENSE_END============================================
y { color: #336699; font-weight: bold } /* Name.Property */ .highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #336699 } /* Name.Variable */ .highlight .ow { color: #008800 } /* Operator.Word */ .highlight .w { color: #bbbbbb } /* Text.Whitespace */ .highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */ .highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */ .highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */ .highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */ .highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */ .highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */ .highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */ .highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */ .highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */ .highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */ .highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */ .highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */ .highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */ .highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */ .highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */ .highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */ .highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */ .highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */ } 
 `For Single install:`_

 `Multi-Site Install:`_

 `Headers:`_

 `AAF Authentication`_

 `AID Authentication Non-AAF`_

`Onboarding API`_

`Add Application`_

`Get Application`_

`Edit Application`_

`Delete Application`_


Steps to test AAF MUSIC has been enhanced to support applications which are already authenticated using AAF and applications which are not authenticated using AAF.

If an application has already been using AAF, it should have required namespace, userId and password.

**Non AAF applications (AID)** Works just like AAF but Namespace is an app name and MUSIC manages the User instead of AAF

All the required params should be sent as headers.

Changed in Cassandra: Admin needs to create the following keyspace and table.

In the cassandra bin dir run ./cqlsh and log in to db then:

If you want to save the following in a file you can then run ./cqlsh -f <file.cql>

For Single install:
^^^^^^^^^^^^^^^^^^^
::

  //Create Admin Keyspace
   
  CREATE KEYSPACE admin
    WITH REPLICATION = {
      'class' : 'SimpleStrategy',
      'replication_factor': 1
    } 
  AND DURABLE_WRITES = true;
 
    CREATE TABLE admin.keyspace_master (
     uuid uuid,
     keyspace_name text,
     application_name text,
     is_api boolean,
     password text,
     username text,
     is_aaf boolean,
     PRIMARY KEY (uuid)
    );


Multi-Site Install:
^^^^^^^^^^^^^^^^^^^

::

  //Create Admin Keyspace
 
  CREATE KEYSPACE admin
  WITH REPLICATION = {
    'class' : 'NetworkTopologyStrategy',
    'DC1':2
  }
  AND DURABLE_WRITES = true;
 
  CREATE TABLE admin.keyspace_master (
   uuid uuid,
   keyspace_name text,
   application_name text,
   is_api boolean,
   password text,
   username text,
   is_aaf boolean,
   PRIMARY KEY (uuid)
 );

Headers:
^^^^^^^^

For AAF applications all the 3 headers ns, userId and password are mandatory.

For Non AAF applications if aid is not provided MUSIC creates new random unique UUID and returns to caller.

Caller application then need to save the UUID and need to pass the UUID to further modify/access the keyspace.

Required Headers

AAF Authentication
^^^^^^^^^^^^^^^^^^
::

  Key     : Value        : Description 
  ns      : org.onap.aaf : AAF Namespace
  userId  : username     : USer Id
  password: password     : Password of User

AID Authentication Non-AAF
^^^^^^^^^^^^^^^^^^^^^^^^^^

::

  Key     : Value        : Description 
  ns      : App Name     : App Name
  userId  : username     : Username for this user (Required during Create keyspace Only)
  password: password     : Password for this user (Required during Create keyspace Only)

Onboarding API
^^^^^^^^^^^^^^

Add Application
^^^^^^^^^^^^^^^

::

  POST URL: /MUSIC/rest/v2/admin/onboardAppWithMusic  with JSON as follows:

  {
   "appname": "<the Namespace for aaf or the Identifier for the specific app using AID access",
   "userId" : "<userid>",
   "isAAF"  : true/false,
   "password" : ""
 }
  
Get Application
^^^^^^^^^^^^^^^

::

  POST URL: /MUSIC/rest/v2/admin/search  with JSON as follows:

  {
   "appname": "<the Namespace for aaf or the Identifier for the specific app using AID access",
   "isAAF"  : true/false,
   "aid" : "Unique ID for this user"
  }
  
Edit Application
^^^^^^^^^^^^^^^^

::

  PUT URL: /MUSIC/rest/v2/admin/onboardAppWithMusic  with JSON as follows: 

  {
  "aid" : "Unique ID for this user",
  "appname": "<the Namespace for aaf or the Identifier for the specific app using AID access",
  "userId" : "<userid>",
  "isAAF"  : true/false,
  "password" : ""
  }
  
Delete Application
^^^^^^^^^^^^^^^^^^

::

  DELETE URL: /MUSIC/rest/v2/admin/onboardAppWithMusic  with JSON as follows:

 {
 "aid" : "Unique ID for this app"
 }