Adds SOL004 folder

                                 Apache License

                           Version 2.0, January 2004

                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,

      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by

      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all

      other entities that control, are controlled by, or are under common

      control with that entity. For the purposes of this definition,

      "control" means (i) the power, direct or indirect, to cause the

      direction or management of such entity, whether by contract or

      otherwise, or (ii) ownership of fifty percent (50%) or more of the

      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity

      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,

      including but not limited to software source code, documentation

      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical

      transformation or translation of a Source form, including but

      not limited to compiled object code, generated documentation,

      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or

      Object form, made available under the License, as indicated by a

      copyright notice that is included in or attached to the work

      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object

      form, that is based on (or derived from) the Work and for which the

      editorial revisions, annotations, elaborations, or other modifications

      represent, as a whole, an original work of authorship. For the purposes

      of this License, Derivative Works shall not include works that remain

      separable from, or merely link (or bind by name) to the interfaces of,

      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including

      the original version of the Work and any modifications or additions

      to that Work or Derivative Works thereof, that is intentionally

      submitted to Licensor for inclusion in the Work by the copyright owner

      or by an individual or Legal Entity authorized to submit on behalf of

      the copyright owner. For the purposes of this definition, "submitted"

      means any form of electronic, verbal, or written communication sent

      to the Licensor or its representatives, including but not limited to

      communication on electronic mailing lists, source code control systems,

      and issue tracking systems that are managed by, or on behalf of, the

      Licensor for the purpose of discussing and improving the Work, but

      excluding communication that is conspicuously marked or otherwise

      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity

      on behalf of whom a Contribution has been received by Licensor and

      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of

      this License, each Contributor hereby grants to You a perpetual,

      worldwide, non-exclusive, no-charge, royalty-free, irrevocable

      copyright license to reproduce, prepare Derivative Works of,

      publicly display, publicly perform, sublicense, and distribute the

      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of

      this License, each Contributor hereby grants to You a perpetual,

      worldwide, non-exclusive, no-charge, royalty-free, irrevocable

      (except as stated in this section) patent license to make, have made,

      use, offer to sell, sell, import, and otherwise transfer the Work,

      where such license applies only to those patent claims licensable

      by such Contributor that are necessarily infringed by their

      Contribution(s) alone or by combination of their Contribution(s)

      with the Work to which such Contribution(s) was submitted. If You

      institute patent litigation against any entity (including a

      cross-claim or counterclaim in a lawsuit) alleging that the Work

      or a Contribution incorporated within the Work constitutes direct

      or contributory patent infringement, then any patent licenses

      granted to You under this License for that Work shall terminate

      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the

      Work or Derivative Works thereof in any medium, with or without

      modifications, and in Source or Object form, provided that You

      meet the following conditions:

      (a) You must give any other recipients of the Work or

          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices

          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works

          that You distribute, all copyright, patent, trademark, and

          attribution notices from the Source form of the Work,

          excluding those notices that do not pertain to any part of

          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its

          distribution, then any Derivative Works that You distribute must

          include a readable copy of the attribution notices contained

          within such NOTICE file, excluding those notices that do not

          pertain to any part of the Derivative Works, in at least one

          of the following places: within a NOTICE text file distributed

          as part of the Derivative Works; within the Source form or

          documentation, if provided along with the Derivative Works; or,

          within a display generated by the Derivative Works, if and

          wherever such third-party notices normally appear. The contents

          of the NOTICE file are for informational purposes only and

          do not modify the License. You may add Your own attribution

          notices within Derivative Works that You distribute, alongside

          or as an addendum to the NOTICE text from the Work, provided

          that such additional attribution notices cannot be construed

          as modifying the License.

      You may add Your own copyright statement to Your modifications and

      may provide additional or different license terms and conditions

      for use, reproduction, or distribution of Your modifications, or

      for any such Derivative Works as a whole, provided Your use,

      reproduction, and distribution of the Work otherwise complies with

      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,

      any Contribution intentionally submitted for inclusion in the Work

      by You to the Licensor shall be under the terms and conditions of

      this License, without any additional terms or conditions.

      Notwithstanding the above, nothing herein shall supersede or modify

      the terms of any separate license agreement you may have executed

      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade

      names, trademarks, service marks, or product names of the Licensor,

      except as required for reasonable and customary use in describing the

      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or

      agreed to in writing, Licensor provides the Work (and each

      Contributor provides its Contributions) on an "AS IS" BASIS,

      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or

      implied, including, without limitation, any warranties or conditions

      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A

      PARTICULAR PURPOSE. You are solely responsible for determining the

      appropriateness of using or redistributing the Work and assume any

      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,

      whether in tort (including negligence), contract, or otherwise,

      unless required by applicable law (such as deliberate and grossly

      negligent acts) or agreed to in writing, shall any Contributor be

      liable to You for damages, including any direct, indirect, special,

      incidental, or consequential damages of any character arising as a

      result of this License or out of the use or inability to use the

      Work (including but not limited to damages for loss of goodwill,

      work stoppage, computer failure or malfunction, or any and all

      other commercial damages or losses), even if such Contributor

      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing

      the Work or Derivative Works thereof, You may choose to offer,

      and charge a fee for, acceptance of support, warranty, indemnity,

      or other liability obligations and/or rights consistent with this

      License. However, in accepting such obligations, You may act only

      on Your own behalf and on Your sole responsibility, not on behalf

      of any other Contributor, and only if You agree to indemnify,

      defend, and hold each Contributor harmless for any liability

      incurred by, or claims asserted against, such Contributor by reason

      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   APPENDIX: How to apply the Apache License to your work.

      To apply the Apache License to your work, attach the following

      boilerplate notice, with the fields enclosed by brackets "{}"

      replaced with your own identifying information. (Don't include

      the brackets!)  The text should be enclosed in the appropriate

      comment syntax for the file format. We also recommend that a

      file or class name and description of purpose be included on the

      same "printed page" as the copyright notice for easier

      identification within third-party archives.

   Copyright {yyyy} {name of copyright owner}

   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.

# README

## Cloning the repo

You need to clone the repo with the option "--recursive" to fetch all the dependent git modules:

```bash

# Clone with SSH

git clone --recursive ssh://git@osm.etsi.org:29419/vnf-onboarding/osm-packages.git

# Clone with HTTPS

git clone --recursive https://osm.etsi.org/gitlab/vnf-onboarding/osm-packages.git

```

## Structure of the repo

This repo contains OSM packages used for testing and for the hackfest.

There is typically a folder for each VNF under test and NS to run the test, for instance:

- `hackfest_basic_vnf`: the VNF package to run the hackfest basic test

- `hackfest_basic_ns`: the NS package to run the hackfest basic test

Please use the following conventions:

- VNF folders should end with "_vnf"

- NS folders should end with "_ns"

Charm sources must be stored in the folder of the package, in `charms/layers` folder. If relations are in place, the charm interfaces must be stored in `charms/interfaces` folder.

Thanks to the new way for building and generating packages, charms sources can be placed directly in the package folder, under `charms/layers/` folder, thus simplifying the structure. When building the package, the charm will be built and only the binaries will be placed in the tar.gz file.

## Working with packages

Osmclient has been improved so that all utilities required to validate and build the packages have been

added. Now the single `osm` command line client is able to do everything you need to work with VNF and

NS packages.

### Uploading a package from a folder

This is by far the simplest way of working. The following command will validate the package,

build the charm from source if it exists under `PKGFOLDER/charms/layers`, build the tar.gz,

and onboard/upload it to OSM.

```bash

osm nfpkg-create PKGFOLDER

```

For NS packages, the same applies.

```bash

osm nspkg-create PKGFOLDER

```

Full help for both commands is show below:

```bash

$ osm nfpkg-create --help

Usage: osm nfpkg-create [OPTIONS] FILENAME

  onboards a new NFpkg (alias of nfpkg-create)

  FILENAME: NF Package tar.gz file, NF Descriptor YAML file or NF Package folder

            If FILENAME is a file (NF Package tar.gz or NF Descriptor YAML), it is onboarded.

            If FILENAME is an NF Package folder, it is built and then onboarded.

Options:

  --overwrite TEXT     Deprecated. Use override

  --override TEXT      overrides fields in descriptor, format: "key1.key2...=value[;key3...=value;...]"

  --skip-charm-build   The charm will not be compiled, it is assumed to already exist

  --override-epa       adds guest-epa parameters to all VDU

  --override-nonepa    removes all guest-epa parameters from all VDU

  --override-paravirt  overrides all VDU interfaces to PARAVIRT

  -h, --help           Show this message and exit.

```

```bash

$ osm nspkg-create --help

Usage: osm nspkg-create [OPTIONS] FILENAME

  onboards a new NSpkg

  FILENAME: NF Package tar.gz file, NF Descriptor YAML file or NF Package folder

            If FILENAME is a file (NF Package tar.gz or NF Descriptor YAML), it is onboarded.

            If FILENAME is an NF Package folder, it is built and then onboarded.

Options:

  --overwrite TEXT    Deprecated. Use override

  --override TEXT     overrides fields in descriptor, format: "key1.key2...=value[;key3...=value;...]"

  --skip-charm-build  The charm will not be compiled, it is assumed to already exist

  -h, --help          Show this message and exit.

```

### Validating a descriptor

The following command will look for all the descriptor files in a folder and validate them

```bash

osm package-validate PKGFOLDER

```

Some relevant options are shown below:

```bash

$ osm package-validate --help

Usage: osm package-validate [OPTIONS] [BASE_DIRECTORY]

  Validate descriptors given a base directory.

  BASE_DIRECTORY: Stub folder for NS, VNF or NST package.

Options:

  --recursive / --no-recursive  The activated recursive option will validate the yaml files within the indicated directory and in its subdirectories

  -h, --help                    Show this message and exit.

```

### Building a package

The following command will validate and build the tar.gz file. It will als

```bash

osm package-build PKGFOLDER

```

Some relevant options are shown below:

```bash

$ osm package-build --help

Usage: osm package-build [OPTIONS] PACKAGE_FOLDER

  Build the package NS, VNF given the package_folder.

  PACKAGE_FOLDER: Folder of the NS, VNF or NST to be packaged

Options:

  --skip-validation   skip package validation

  --skip-charm-build  the charm will not be compiled, it is assumed to already exist

  -h, --help          Show this message and exit.

```

### Creating a package structure

The best way to work is by copying a previous one that is up-to-date. But you can also create

a first skeleton using this command:

```bash

Usage: osm package-create [OPTIONS] PACKAGE_TYPE PACKAGE_NAME

  Creates an OSM NS, VNF, NST package

  PACKAGE_TYPE: Package to be created: NS, VNF or NST.

  PACKAGE_NAME: Name of the package to create the folder with the content.

Options:

  --base-directory TEXT       (NS/VNF/NST) Set the location for package creation. Default: "."

  --image TEXT                (VNF) Set the name of the vdu image. Default "image-name"

  --vdus INTEGER              (VNF) Set the number of vdus in a VNF. Default 1

  --vcpu INTEGER              (VNF) Set the number of virtual CPUs in a vdu. Default 1

  --memory INTEGER            (VNF) Set the memory size (MB) of the vdu. Default 1024

  --storage INTEGER           (VNF) Set the disk size (GB) of the vdu. Default 10

  --interfaces INTEGER        (VNF) Set the number of additional interfaces apart from the management interface. Default 0

  --vendor TEXT               (NS/VNF) Set the descriptor vendor. Default "OSM"

  --override                  (NS/VNF/NST) Flag for overriding the package if exists.

  --detailed                  (NS/VNF/NST) Flag for generating descriptor .yaml with all possible commented options

  --netslice-subnets INTEGER  (NST) Number of netslice subnets. Default 1

  --netslice-vlds INTEGER     (NST) Number of netslice vlds. Default 1

  -h, --help                  Show this message and exit.

```

nsd:

  nsd:

  - id: ha_proxy_charm-ns

    name: ha_proxy_charm-ns

    version: '1.0'

    description: NS with 2 VNFs with cloudinit connected by datanet and mgmtnet VLs

    df:

    - id: default-df

      vnf-profile:

      - id: '1'

        virtual-link-connectivity:

        - constituent-cpd-id:

          - constituent-base-element-id: '1'

            constituent-cpd-id: vnf-mgmt-ext

          virtual-link-profile-id: mgmtnet

        - constituent-cpd-id:

          - constituent-base-element-id: '1'

            constituent-cpd-id: vnf-data-ext

          virtual-link-profile-id: datanet

        vnfd-id: ha_proxy_charm-vnf

      - id: '2'

        virtual-link-connectivity:

        - constituent-cpd-id:

          - constituent-base-element-id: '2'

            constituent-cpd-id: vnf-mgmt-ext

          virtual-link-profile-id: mgmtnet

        - constituent-cpd-id:

          - constituent-base-element-id: '2'

            constituent-cpd-id: vnf-data-ext

          virtual-link-profile-id: datanet

        vnfd-id: ha_proxy_charm-vnf

    virtual-link-desc:

    - id: mgmtnet

      mgmt-network: 'true'

    - id: datanet

    vnfd-id:

    - ha_proxy_charm-vnf

##

# Copyright 2020 Canonical Ltd.

# 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.

##

touch:

  description: "Touch a file on the VNF."

  params:

    filename:

      description: "The name of the file to touch."

      type: string

      default: ""

  required:

    - filename

# Standard OSM functions

start:

  description: "Stop the service on the VNF."

stop:

  description: "Stop the service on the VNF."

restart:

  description: "Stop the service on the VNF."

reboot:

  description: "Reboot the VNF virtual machine."

upgrade:

  description: "Upgrade the software on the VNF."

# Required by charms.osm.sshproxy

run:

  description: "Run an arbitrary command"

  params:

    command:

      description: "The command to execute."

      type: string

      default: ""

  required:

    - command

generate-ssh-key:

  description: "Generate a new SSH keypair for this unit. This will replace any existing previously generated keypair."

verify-ssh-credentials:

  description: "Verify that this unit can authenticate with server specified by ssh-hostname and ssh-username."

get-ssh-public-key:

  description: "Get the public SSH key for this unit."