file structure

Typical file structure

Workspace file structure

When creating a new workspace with the tng-workspace command, a file structure and configuration files are generated automatically (usually at ~\.tng-workspace). This workspace is then used for all projects unless specified otherwise. The typical file structure of the workspace is the following:

+- .tng-project
|  +- catalogues
|  +- configuration
|  +- platforms
|  +- projects
   |  +- config.yml
|  +- workspace.yml

The file workspace.yml holds metadata of the workspace as well as links to the tng-schema repository and access credentials for the service platforms. Further configuration files should be added in the corresponding directories. As an example, config.yml inside the projects folder is used when adding files to a project with tng-project --add for mapping yml-files to the correct MIME type.

Project file structure

Every project has a typical file structure, which is generated automatically when creating a new project. The file structure is illustrated below:

+- projectname
|  +- dependencies
|  +- deployment
|  +- sources
   |  +- nsd
   |  +- vnfd
|  +- project.yml

Users are suggested to add their project files in the corresponding directories for an easy structure. For example, all descriptors should be located in corresponding subfolders of the sources directory. However, this structure is not mandatory and files can be added to the project from anywhere within the project folder using the tng-project --add command.