summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-user/design/resource-onboarding/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/guides/onap-user/design/resource-onboarding/index.rst')
-rw-r--r--docs/guides/onap-user/design/resource-onboarding/index.rst14
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/guides/onap-user/design/resource-onboarding/index.rst b/docs/guides/onap-user/design/resource-onboarding/index.rst
index 7154bb833..2c7020d7d 100644
--- a/docs/guides/onap-user/design/resource-onboarding/index.rst
+++ b/docs/guides/onap-user/design/resource-onboarding/index.rst
@@ -16,11 +16,11 @@ Resource Onboarding
|image0|
**Steps**
- * `Create a License Model`_
- * `Create a License Key Group [Optional]`_
- * `Create an Entitlement Pool`_
- * `Create a Feature Group`_
- * `Create a License Agreement`_
+ * `Create a License Model [Optional]`_
+ * `Create a License Key Group [Optional]`_
+ * `Create an Entitlement Pool`_
+ * `Create a Feature Group`_
+ * `Create a License Agreement`_
* `Create a Vendor Software Product`_
* `Update VFCs in a VSP [optional]`_
* `Update a VSP [optional]`_
@@ -33,8 +33,8 @@ After updating the artifacts in a VSP, also update:
.. _doc_guide_user_des_res-onb_cre-lic:
-Create a License Model
-----------------------
+Create a License Model [Optional]
+---------------------------------
VSPs optionally require a license and entitlements to enable the service
provider to track the usage.
2 } /* Name.Label */ .highlight .nn { color: #f8f8f2 } /* Name.Namespace */ .highlight .nx { color: #a6e22e } /* Name.Other */ .highlight .py { color: #f8f8f2 } /* Name.Property */ .highlight .nt { color: #f92672 } /* Name.Tag */ .highlight .nv { color: #f8f8f2 } /* Name.Variable */ .highlight .ow { color: #f92672 } /* Operator.Word */ .highlight .w { color: #f8f8f2 } /* Text.Whitespace */ .highlight .mb { color: #ae81ff } /* Literal.Number.Bin */ .highlight .mf { color: #ae81ff } /* Literal.Number.Float */ .highlight .mh { color: #ae81ff } /* Literal.Number.Hex */ .highlight .mi { color: #ae81ff } /* Literal.Number.Integer */ .highlight .mo { color: #ae81ff } /* Literal.Number.Oct */ .highlight .sa { color: #e6db74 } /* Literal.String.Affix */ .highlight .sb { color: #e6db74 } /* Literal.String.Backtick */ .highlight .sc { color: #e6db74 } /* Literal.String.Char */ .highlight .dl { color: #e6db74 } /* Literal.String.Delimiter */ .highlight .sd { color: #e6db74 } /* Literal.String.Doc */ .highlight .s2 { color: #e6db74 } /* Literal.String.Double */ .highlight .se { color: #ae81ff } /* Literal.String.Escape */ .highlight .sh { color: #e6db74 } /* Literal.String.Heredoc */ .highlight .si { color: #e6db74 } /* Literal.String.Interpol */ .highlight .sx { color: #e6db74 } /* Literal.String.Other */ .highlight .sr { color: #e6db74 } /* Literal.String.Regex */ .highlight .s1 { color: #e6db74 } /* Literal.String.Single */ .highlight .ss { color: #e6db74 } /* Literal.String.Symbol */ .highlight .bp { color: #f8f8f2 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #a6e22e } /* Name.Function.Magic */ .highlight .vc { color: #f8f8f2 } /* Name.Variable.Class */ .highlight .vg { color: #f8f8f2 } /* Name.Variable.Global */ .highlight .vi { color: #f8f8f2 } /* Name.Variable.Instance */ .highlight .vm { color: #f8f8f2 } /* Name.Variable.Magic */ .highlight .il { color: #ae81ff } /* Literal.Number.Integer.Long */ } @media (prefers-color-scheme: light) { .highlight .hll { background-color: #ffffcc } .highlight .c { color: #888888 } /* Comment */ .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */ .highlight .k { color: #008800; font-weight: bold } /* Keyword */ .highlight .ch { color: #888888 } /* Comment.Hashbang */ .highlight .cm { color: #888888 } /* Comment.Multiline */ .highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */ .highlight .cpf { color: #888888 } /* Comment.PreprocFile */ .highlight .c1 { color: #888888 } /* Comment.Single */ .highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */ .highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */ .highlight .ge { font-style: italic } /* Generic.Emph */ .highlight .gr { color: #aa0000 } /* Generic.Error */ .highlight .gh { color: #333333 } /* Generic.Heading */ .highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */ .highlight .go { color: #888888 } /* Generic.Output */ .highlight .gp { color: #555555 } /* Generic.Prompt */ .highlight .gs { font-weight: bold } /* Generic.Strong */ .highlight .gu { color: #666666 } /* Generic.Subheading */ .highlight .gt { color: #aa0000 } /* Generic.Traceback */ .highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */ .highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */ .highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */ .highlight .kp { color: #008800 } /* Keyword.Pseudo */ .highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */ .highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */ .highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */ .highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */ .highlight .na { color: #336699 } /* Name.Attribute */ .highlight .nb { color: #003388 } /* Name.Builtin */ .highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */ .highlight .no { color: #003366; font-weight: bold } /* Name.Constant */ .highlight .nd { color: #555555 } /* Name.Decorator */ .highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */ .highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */ .highlight .nl { color: #336699; font-style: italic } /* Name.Label */ .highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */ .highlight .py { 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 */ }
/*-
 * ============LICENSE_START=======================================================
 * SDC
 * ================================================================================
 * Copyright (C) 2017 AT&T Intellectual Property. 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=========================================================
 */

/**
 * Created by obarda on 4/20/2016.
 */
'use strict';
import {PropertyModel} from "./properties";
import {Requirement} from "./requirement";

export interface RequirementCapabilityModel{};
//this is an object contains keys, when each key has matching array.
// for example: key = tosca.capabilities.network.Linkable and the match array is array of capabilities objects
export class CapabilitiesGroup {
    constructor(capabilityGroupObj?:CapabilitiesGroup) {
        _.forEach(capabilityGroupObj, (capabilitiesArrayObj:Array<Capability>, instance) => {
            this[instance] = [];
            _.forEach(capabilitiesArrayObj, (capability:Capability):void => {
                this[instance].push(new Capability(capability));
            });
        });
    }

    public findValueByKey(keySubstring:string):Array<Capability> {
        let key:string = _.find(Object.keys(this), (key)=> {
            return _.includes(key.toLowerCase(), keySubstring);
        });
        return this[key];
    }
}

export class Capability implements RequirementCapabilityModel{

    //server data
    name:string;
    ownerId:string;
    ownerName:string;
    type:string;
    uniqueId:string;
    capabilitySources:Array<String>;
    leftOccurrences:string;
    minOccurrences:string;
    maxOccurrences:string;
    description:string;
    validSourceTypes:Array<string>;
    properties:Array<PropertyModel>;
    //custom
    selected:boolean;
    filterTerm:string;

    constructor(capability?:Capability) {

        if (capability) {
            //server data
            this.name = capability.name;
            this.ownerId = capability.ownerId;
            this.ownerName = capability.ownerName;
            this.type = capability.type;
            this.uniqueId = capability.uniqueId;
            this.capabilitySources = capability.capabilitySources;
            this.leftOccurrences = capability.leftOccurrences;
            this.minOccurrences = capability.minOccurrences;
            this.maxOccurrences = capability.maxOccurrences;
            this.properties = capability.properties;
            this.description = capability.description;
            this.validSourceTypes = capability.validSourceTypes;
            this.selected = capability.selected;
            this.initFilterTerm();

        }
    }

    public getTitle():string {
        return this.ownerName + ': ' + this.name;
    }

    public getFullTitle():string {
        let maxOccurrences:string = this.maxOccurrences === 'UNBOUNDED' ? '∞' : this.maxOccurrences;
        return this.getTitle() + ': [' + this.minOccurrences + ', ' + maxOccurrences + ']';
    }

    public toJSON = ():any => {
        this.selected = undefined;
        this.filterTerm = undefined;
        return this;
    };

    private initFilterTerm = ():void => {
        this.filterTerm = this.name + " " +
            (this.type ? (this.type.replace("tosca.capabilities.", "") + " " ) : "") +
            (this.description || "") + " " +
            (this.ownerName || "") + " " +
            (this.validSourceTypes ? (this.validSourceTypes.join(',') + " ") : "") +
            this.minOccurrences + "," + this.maxOccurrences;
        if (this.properties && this.properties.length) {
            _.forEach(this.properties, (prop:PropertyModel)=> {
                this.filterTerm += " " + prop.name +
                    " " + (prop.description || "") +
                    " " + prop.type +
                    (prop.schema && prop.schema.property ? (" " + prop.schema.property.type) : "");
            });
        }
    }

    public isFulfilled() {
        return parseInt(this.leftOccurrences) === 0;
    }
}