Commit 78492903 authored by Francisco-Javier Ramon Salguero's avatar Francisco-Javier Ramon Salguero
Browse files

Fixed minor format issues in chapter 06

parent 2ec02dd2
......@@ -133,7 +133,6 @@ The Keystone component will configure itself at startup time using a few environ
- **`LDAP_TLS_REQ_CERT`**: Defines how the certificates are checked for validity in the client (i.e., Keystone end) of the secure connection (this doesn’t affect what level of checking the server is doing on the certificates it receives from Keystone). Possible values are "demand", "never", and "allow". The default of demand means the client always checks the certificate and will drop the connection if it is not provided or invalid. never is the opposite—it never checks it, nor requires it to be provided. allow means that if it is not provided then the connection is allowed to continue, but if it is provided it will be checked—and if invalid, the connection will be dropped.
- **`LDAP_TLS_CACERT_BASE64`**: CA certificate in Base64 format (if you have the PEM file, text inside `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----` tags).
## VIM management
TODO: Page in elaboration.
......@@ -413,7 +412,6 @@ osm repo-list
### Kubernetes build
## OSM Repositories
The Network Services are described as network functions that can be composed, to provide more complex NaaS; several components describe the function as NSD, VNFD and VIM images. These are packaged encapsulating all necessary information in addition to the descriptor file:
......@@ -424,11 +422,10 @@ The Network Services are described as network functions that can be composed, to
Based on this information, It is crucial to have a clear knowledge on how this information is stored and the mechanisms to retrieve it by OSM to onboard and instantiate the Service in the underlying infrastructure. Accordingly, and in contemplation of alleviate the consumption of the NS in a standardized way, a distribution mechanism and efficient packaging standard is introduced as a new feature to be published.
The OSM Repository brings several improvements on the management and consumption of Network Services and the interaction with the repository. This section defines a standardized model format to implement a consumption mechanism for a remote NS repository, that could be queried and managed by OSM abstracting from the actual storage mechanism; the interface will be exposed by HTTP requests.
The OSM Repository brings several improvements on the management and consumption of Network Services and the interaction with the repository. This section defines a standardized model format to implement a consumption mechanism for a remote NS repository, that could be queried and managed by OSM abstracting from the actual storage mechanism; the interface will be exposed by HTTP requests.
This approach will allow other NS developers for publishing and onboard their services, pushing local artefacts and dependencies of the VNFs to the remote repository. The following figure depicts the interconnection between the OSM and the external standardized repository.
![OSM repositories](./assets/800px-OSM_repo.png)
### OSM repository: server side
......@@ -440,13 +437,13 @@ In both cases, the repository must have the following structure:
- A specific folder structure (trying to be self-explanatory)
- One artifact's version and its metadata per folder
#### Structure of the OSM repository:
#### Structure of the OSM repository
The OSM Repository has the following files structure:
The OSM Repository has the following file structure:
```bash
repository/
├── index.yaml
├── index.yaml
├── ns/
│ └── <ns_id>/
│ └── <ns_version>/
......@@ -459,7 +456,7 @@ repository/
└── <vnf_id>-<vnf_version>.tar.gz
```
The `index.yaml` is in charge of managing the packages' versions and it has the following structure:
The `index.yaml` is in charge of managing packages versions and has the following structure:
```yaml
apiVersion: v1
......@@ -483,7 +480,7 @@ vnf_packages:
latest: <vnf_pkg_latest_version:String>
```
One example of an OSM Repository index file could be the following:
Here is an example of OSM Repository index file:
```yaml
apiVersion: v1
......@@ -512,7 +509,8 @@ vnf_packages:
latest: '2.0'
```
Finally, the last configuration file is the `metadata.yaml`. This file has the most valuable data of a package. This file is in the same root of the package that descibed and its content is the following:
Finally, the last configuration file is the `metadata.yaml`. This file has the most valuable data of a package. This file is in the same root of the package that described and its content is the following:
- Network Service Package `metadata.yaml` example:
```yaml
......@@ -542,7 +540,7 @@ path: /vnf/cirros_vnfd/1.0/cirros_vnfd-2.0.tar.gz
checksum: e7c9dec0efbab0986afe9e8d64c402f9
```
#### OSM repository generation:
#### OSM repository generation
For generating an OSM Repository automatically, the OSM Client provides a useful command in charge of the ETL required to convert a directory containing packages and sources into an OSM repository. This command is the same as to create a repository or update the existing OSM Repository with more packages:
......@@ -550,7 +548,7 @@ For generating an OSM Repository automatically, the OSM Client provides a useful
osm repo-index --origin <packages_folder> --destination <repository_folder>
```
Once It is executed we can find in the destination folder the directory to be exposed via HTTP.
Once it is executed we can find in the destination folder the directory to be exposed via HTTP.
With the following docker container it is pretty easy to expose a directory via http:
......@@ -562,7 +560,6 @@ docker run -v <repository_path>:/repository -p 80:80 luisupm/repository_export
From the OSM client, It is possible to manage the usage of the repositories in OSM. Through simple commands we can associate repositories, list the artefacts available in them and onboard packages from the repository. The following commands will describe in detail the functionalities that the OSM Client can deal with the OSM Repositories:
In order to **add a new repo**, the user should invoke the following command:
```bash
......@@ -571,8 +568,8 @@ osm repo-add --description <repo description> <repo name> <repository_url>
This call will trigger the following actions in OSM:
1. Save this information in the common database.
2. Invoke the repo_add operation with the known OSM Repository.
1. Save this information in the common database.
2. Invoke the repo_add operation with the known OSM Repository.
Conversely, a **repo can be removed** with:
......@@ -582,8 +579,8 @@ osm repo-delete vnfrepo
Likewise, this operation would:
1. Update the common database accordingly.
2. Invoke the repo_remove operation with the OSM Repository.
1. Update the common database accordingly.
2. Invoke the repo_remove operation with the OSM Repository.
At any moment, it is also possible to get the **list of repos** known by OSM:
......@@ -592,44 +589,45 @@ osm repo-list
```
Once there is a OSM Repository added in the system, it is posible **list packages inside a repository**, by VNF or NS packages:
- VNF packages:
```bash
osm vnfpkg-repo-list
osm nfpkg-repo-list
```
These comands will retrive a list with all the VNF packages available in the repository
- NS packages:
```bash
osm nsd-repo-list
- VNF packages:
```bash
osm vnfpkg-repo-list
osm nfpkg-repo-list
```
osm nspkg-repo-list
```
These commands will retrieve a list with all the VNF packages available in the repository:
These comands will retrived a list with all the NS packages available in the repository
- NS packages:
```bash
osm nsd-repo-list
osm nspkg-repo-list
```
These commands will retrieve a list with all the NS packages available in the repository.
To **On-board a package from a repository** to OSM it is possible to use the following commands:
- VNF packages:
```bash
osm vnfpkg-create --repo vnfrepo <vnf>
- VNF packages:
```bash
osm vnfpkg-create --repo vnfrepo <vnf>
osm nfpkg-create --repo vnfrepo <vnf>
```
osm nfpkg-create --repo vnfrepo <vnf>
```
- NS packages:
- NS packages:
```bash
osm nsd-create --repo vnfrepo <nsd>
```bash
osm nsd-create --repo vnfrepo <nsd>
osm nspkg-create --repo vnfrepo <nsd>
```
osm nspkg-create --repo vnfrepo <nsd>
```
To **show packages details** available in the repository it is posible use the following commands:
- VNF packages:
- VNF packages:
```bash
osm vnfpkg-repo-show --repo vnfrepo <vnf>
......@@ -637,6 +635,7 @@ To **show packages details** available in the repository it is posible use the f
```
- NS packages:
```bash
osm nsd-repo-show --repo vnfrepo <nsd>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment