Skip to content
Snippets Groups Projects
Commit 09b81acd authored by Kostis Trantzas's avatar Kostis Trantzas
Browse files

Merge branch 'main' into develop

parents 864ecbe2 304ee566
Branches
Tags
2 merge requests!11Merging "develop" documentation into "main" to tag it as 2024Q2,!9Draft: Added documentation on primitives support feature and NSLCM status
Pipeline #4485 passed
Stage: deploy
Expand all Show whitespace changes
Inline Side-by-side
Showing
with 841 additions and 498 deletions
LICENSE 0 → 100644
+ 331
− 0
View file @ 09b81acd
OSL documentation (c) by ETSI
OSL documentation is licensed under a
Creative Commons Attribution 4.0 International License.
You can fine the license below and at <https://creativecommons.org/licenses/by/4.0/>.
=======================================================================
Creative Commons Attribution 4.0 International Public License
By exercising the Licensed Rights (defined below), You accept and agree
to be bound by the terms and conditions of this Creative Commons
Attribution 4.0 International Public License ("Public License"). To the
extent this Public License may be interpreted as a contract, You are
granted the Licensed Rights in consideration of Your acceptance of
these terms and conditions, and the Licensor grants You such rights in
consideration of benefits the Licensor receives from making the
Licensed Material available under these terms and conditions.
Section 1 -- Definitions.
a. Adapted Material means material subject to Copyright and Similar
Rights that is derived from or based upon the Licensed Material
and in which the Licensed Material is translated, altered,
arranged, transformed, or otherwise modified in a manner requiring
permission under the Copyright and Similar Rights held by the
Licensor. For purposes of this Public License, where the Licensed
Material is a musical work, performance, or sound recording,
Adapted Material is always produced where the Licensed Material is
synched in timed relation with a moving image.
b. Adapter's License means the license You apply to Your Copyright
and Similar Rights in Your contributions to Adapted Material in
accordance with the terms and conditions of this Public License.
c. Copyright and Similar Rights means copyright and/or similar rights
closely related to copyright including, without limitation,
performance, broadcast, sound recording, and Sui Generis Database
Rights, without regard to how the rights are labeled or
categorized. For purposes of this Public License, the rights
specified in Section 2(b)(1)-(2) are not Copyright and Similar
Rights.
d. Effective Technological Measures means those measures that, in the
absence of proper authority, may not be circumvented under laws
fulfilling obligations under Article 11 of the WIPO Copyright
Treaty adopted on December 20, 1996, and/or similar international
agreements.
e. Exceptions and Limitations means fair use, fair dealing, and/or
any other exception or limitation to Copyright and Similar Rights
that applies to Your use of the Licensed Material.
f. Licensed Material means the artistic or literary work, database,
or other material to which the Licensor applied this Public
License.
g. Licensed Rights means the rights granted to You subject to the
terms and conditions of this Public License, which are limited to
all Copyright and Similar Rights that apply to Your use of the
Licensed Material and that the Licensor has authority to license.
h. Licensor means the individual(s) or entity(ies) granting rights
under this Public License.
i. Share means to provide material to the public by any means or
process that requires permission under the Licensed Rights, such
as reproduction, public display, public performance, distribution,
dissemination, communication, or importation, and to make material
available to the public including in ways that members of the
public may access the material from a place and at a time
individually chosen by them.
j. Sui Generis Database Rights means rights other than copyright
resulting from Directive 96/9/EC of the European Parliament and of
the Council of 11 March 1996 on the legal protection of databases,
as amended and/or succeeded, as well as other essentially
equivalent rights anywhere in the world.
k. You means the individual or entity exercising the Licensed Rights
under this Public License. Your has a corresponding meaning.
Section 2 -- Scope.
a. License grant.
1. Subject to the terms and conditions of this Public License,
the Licensor hereby grants You a worldwide, royalty-free,
non-sublicensable, non-exclusive, irrevocable license to
exercise the Licensed Rights in the Licensed Material to:
a. reproduce and Share the Licensed Material, in whole or
in part; and
b. produce, reproduce, and Share Adapted Material.
2. Exceptions and Limitations. For the avoidance of doubt, where
Exceptions and Limitations apply to Your use, this Public
License does not apply, and You do not need to comply with
its terms and conditions.
3. Term. The term of this Public License is specified in Section
6(a).
4. Media and formats; technical modifications allowed. The
Licensor authorizes You to exercise the Licensed Rights in
all media and formats whether now known or hereafter created,
and to make technical modifications necessary to do so. The
Licensor waives and/or agrees not to assert any right or
authority to forbid You from making technical modifications
necessary to exercise the Licensed Rights, including
technical modifications necessary to circumvent Effective
Technological Measures. For purposes of this Public License,
simply making modifications authorized by this Section 2(a)
(4) never produces Adapted Material.
5. Downstream recipients.
a. Offer from the Licensor -- Licensed Material. Every
recipient of the Licensed Material automatically
receives an offer from the Licensor to exercise the
Licensed Rights under the terms and conditions of this
Public License.
b. No downstream restrictions. You may not offer or impose
any additional or different terms or conditions on, or
apply any Effective Technological Measures to, the
Licensed Material if doing so restricts exercise of the
Licensed Rights by any recipient of the Licensed
Material.
6. No endorsement. Nothing in this Public License constitutes or
may be construed as permission to assert or imply that You
are, or that Your use of the Licensed Material is, connected
with, or sponsored, endorsed, or granted official status by,
the Licensor or others designated to receive attribution as
provided in Section 3(a)(1)(A)(i).
b. Other rights.
1. Moral rights, such as the right of integrity, are not
licensed under this Public License, nor are publicity,
privacy, and/or other similar personality rights; however, to
the extent possible, the Licensor waives and/or agrees not to
assert any such rights held by the Licensor to the limited
extent necessary to allow You to exercise the Licensed
Rights, but not otherwise.
2. Patent and trademark rights are not licensed under this
Public License.
3. To the extent possible, the Licensor waives any right to
collect royalties from You for the exercise of the Licensed
Rights, whether directly or through a collecting society
under any voluntary or waivable statutory or compulsory
licensing scheme. In all other cases the Licensor expressly
reserves any right to collect such royalties.
Section 3 -- License Conditions.
Your exercise of the Licensed Rights is expressly made subject to the
following conditions.
a. Attribution.
1. If You Share the Licensed Material (including in modified
form), You must:
a. retain the following if it is supplied by the Licensor
with the Licensed Material:
i. identification of the creator(s) of the Licensed
Material and any others designated to receive
attribution, in any reasonable manner requested by
the Licensor (including by pseudonym if
designated);
ii. a copyright notice;
iii. a notice that refers to this Public License;
iv. a notice that refers to the disclaimer of
warranties;
v. a URI or hyperlink to the Licensed Material to the
extent reasonably practicable;
b. indicate if You modified the Licensed Material and
retain an indication of any previous modifications; and
c. indicate the Licensed Material is licensed under this
Public License, and include the text of, or the URI or
hyperlink to, this Public License.
2. You may satisfy the conditions in Section 3(a)(1) in any
reasonable manner based on the medium, means, and context in
which You Share the Licensed Material. For example, it may be
reasonable to satisfy the conditions by providing a URI or
hyperlink to a resource that includes the required
information.
3. If requested by the Licensor, You must remove any of the
information required by Section 3(a)(1)(A) to the extent
reasonably practicable.
4. If You Share Adapted Material You produce, the Adapter's
License You apply must not prevent recipients of the Adapted
Material from complying with this Public License.
Section 4 -- Sui Generis Database Rights.
Where the Licensed Rights include Sui Generis Database Rights that
apply to Your use of the Licensed Material:
a. for the avoidance of doubt, Section 2(a)(1) grants You the right
to extract, reuse, reproduce, and Share all or a substantial
portion of the contents of the database;
b. if You include all or a substantial portion of the database
contents in a database in which You have Sui Generis Database
Rights, then the database in which You have Sui Generis Database
Rights (but not its individual contents) is Adapted Material; and
c. You must comply with the conditions in Section 3(a) if You Share
all or a substantial portion of the contents of the database.
For the avoidance of doubt, this Section 4 supplements and does not
replace Your obligations under this Public License where the Licensed
Rights include other Copyright and Similar Rights.
Section 5 -- Disclaimer of Warranties and Limitation of Liability.
a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
c. The disclaimer of warranties and limitation of liability provided
above shall be interpreted in a manner that, to the extent
possible, most closely approximates an absolute disclaimer and
waiver of all liability.
Section 6 -- Term and Termination.
a. This Public License applies for the term of the Copyright and
Similar Rights licensed here. However, if You fail to comply with
this Public License, then Your rights under this Public License
terminate automatically.
b. Where Your right to use the Licensed Material has terminated under
Section 6(a), it reinstates:
1. automatically as of the date the violation is cured, provided
it is cured within 30 days of Your discovery of the
violation; or
2. upon express reinstatement by the Licensor.
For the avoidance of doubt, this Section 6(b) does not affect any
right the Licensor may have to seek remedies for Your violations
of this Public License.
c. For the avoidance of doubt, the Licensor may also offer the
Licensed Material under separate terms or conditions or stop
distributing the Licensed Material at any time; however, doing so
will not terminate this Public License.
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
License.
Section 7 -- Other Terms and Conditions.
a. The Licensor shall not be bound by any additional or different
terms or conditions communicated by You unless expressly agreed.
b. Any arrangements, understandings, or agreements regarding the
Licensed Material not stated herein are separate from and
independent of the terms and conditions of this Public License.
Section 8 -- Interpretation.
a. For the avoidance of doubt, this Public License does not, and
shall not be interpreted to, reduce, limit, restrict, or impose
conditions on any use of the Licensed Material that could lawfully
be made without permission under this Public License.
b. To the extent possible, if any provision of this Public License is
deemed unenforceable, it shall be automatically reformed to the
minimum extent necessary to make it enforceable. If the provision
cannot be reformed, it shall be severed from this Public License
without affecting the enforceability of the remaining terms and
conditions.
c. No term or condition of this Public License will be waived and no
failure to comply consented to unless expressly agreed to by the
Licensor.
d. Nothing in this Public License constitutes or may be interpreted
as a limitation upon, or waiver of, any privileges and immunities
that apply to the Licensor or You, including from the legal
processes of any jurisdiction or authority.
=======================================================================
README.md deleted 100644 → 0
+ 0
− 92
View file @ 864ecbe2
# documentation
## Getting started
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## Add your files
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
```
cd existing_repo
git remote add origin https://labs.etsi.org/rep/osl/documentation.git
git branch -M main
git push -uf origin main
```
## Integrate with your tools
- [ ] [Set up project integrations](https://labs.etsi.org/rep/osl/documentation/-/settings/integrations)
## Collaborate with your team
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## Test and Deploy
Use the built-in continuous integration in GitLab.
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
***
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
doc/contributing/developing.md
+ 39
− 39
View file @ 09b81acd
# Developing
Openslice backend services are mainly implemented with Java 17 or above and Spring boot.
OpenSlice backend services are mainly implemented with Java 17 or above and Spring boot.
Openslice uses various subsystems and depending on the module would you like to work, other subsystems must be present (you can disable them though in the code, e.g. at application.yml file)
OpenSlice uses various subsystems and depending on the module would you like to work, other subsystems must be present (you can disable them though in the code, e.g. at docker-compose.yaml file).
To get the latest development branch:
```bash
wget https://labs.etsi.org/rep/osl/code/org.etsi.osl.main/-/raw/develop/compose/deploy.sh
sudo ./deploy.sh develop #[or replace develop with other branch name]
```
wget https://raw.githubusercontent.com/openslice/org.etsi.osl.main/develop/compose/deploy.sh
sudo ./deploy.sh develop [or replace develop with other branch name]
```
## Slack
* Slack: https://openslice.slack.com
## General subsystems
You may follow the [installation process](https://osl.etsi.org/documentation/develop/deployment/), as described at "develop" tagged documentation.
- Docker and Docker Compose should be installed in your development environment
To work on a specific subsystem e.g. org.etsi.osl.tmf.api, you must:
### Consul
consul service registry should be up and running. You can launch consul with docker:
`sudo docker run -d --name consul -p 8500:8500 -p 8600:8600 consul`
1a - Deploy only the core necessary subsystems through:
```bash
sudo docker compose --profile dev down;sudo docker compose --profile dev up -d --build
```
> Note **--profile dev** that will only deploy the core dependency subsystems, instead of the whole OpenSlice.
### ActiveMQ
ActiveMQ is our messaging system. You can launch an instance of ActiveMQ:
`sudo docker run --name='activemq' -d -e 'ACTIVEMQ_NAME=amqp-srv1' -e 'ACTIVEMQ_REMOVE_DEFAULT_ACCOUNT=true' -e 'ACTIVEMQ_ADMIN_LOGIN=admin' -e 'ACTIVEMQ_ADMIN_PASSWORD=admin' -e 'ACTIVEMQ_WRITE_LOGIN=producer_login' -e 'ACTIVEMQ_WRITE_PASSWORD=producer_password' -e 'ACTIVEMQ_READ_LOGIN=consumer_login' -e 'ACTIVEMQ_READ_PASSWORD=consumer_password' -e 'ACTIVEMQ_JMX_LOGIN=jmx_login' -e 'ACTIVEMQ_JMX_PASSWORD=jmx_password' -e 'ACTIVEMQ_STATIC_TOPICS=topic1;topic2;topic3' -e 'ACTIVEMQ_STATIC_QUEUES=queue1;queue2;queue3' -e 'ACTIVEMQ_MIN_MEMORY=1024' -e 'ACTIVEMQ_MAX_MEMORY=4096' -e 'ACTIVEMQ_ENABLED_SCHEDULER=true' -v /home/ctranoris/testcompose/data/activemq:/data/activemq -v /var/log/activemq:/var/log/activemq -p 8161:8161 -p 61616:61616 -p 61613:61613 webcenter/activemq:5.14.3`
1b - Or alternatively, commend out the respective container from the docker-compose.yaml file, so as to deploy the whole OpenSlice, except the subsystem you want to work on, following the provided installation steps.
### MySQL server
We use mysql as a storage DB. Please make sure that you have it installed in your system. There are instructions on internet how to install it. Check also our docker-compose installation script
2 - Clone the respective repository, e.g. https://labs.etsi.org/rep/osl/code/org.etsi.osl.tmf.api/-/tree/develop
3 - Code :)
## Oauth server
## General requirements
Keycloak is used as the authentication server.
- Docker should be installed in your development environment
- Run the core subsystems (see above section)
> Note: Please check the Post installation steps -> Keycloak at localhost, at [Deployment/Installation](../deployment.md), if you are developing in a local environment
## Slack
## VNF/NSD Catalog Management and NSD Deployment API service
Feel free to join OpenSlice [Slack](https://openslice.slack.com) for any development oriented questions.
Clone the repository: https://github.com/openslice/org.etsi.osl.portal.api
## Examples of developing on specific subsystems
Check the application.yml file. Default port is 13080. Especially the datasource username/password, server port.
### VNF/NSD Catalog Management and NSD Deployment API service
make sure that the General subsystems are up and running as well as the OAuth server
Clone the repository: https://labs.etsi.org/rep/osl/code/org.etsi.osl.portal.api/-/tree/develop
run it with `mvn spring-boot:run`
Check the docker-compose.yml file. Default port is 13080. Check specifically the datasource username/password, server port.
You can check your consul server if it registered.
Make sure that the core subsystems are up and running.
### Swagger API
Swagger API of the service is at `http://localhost:13000/osapi/swagger-ui/`. You can try there various REST actions and authenticate via the OAuth server
Execute it with
```bash
mvn spring-boot:run
```
For verification, Swagger API of the service is at `http://localhost:13000/osapi/swagger-ui/index.html`.
## VNF/NSD Catalog Management and NSD Deployment WEB UI service
There, you may try there various REST actions and authenticate via the OAuth server without the use of the UI.
The Web UI is written in AngularJS
Clone the repository: https://github.com/openslice/org.etsi.osl.portal.web
### VNF/NSD Catalog Management and NSD Deployment WEB UI service
by default the project org.etsi.osl.portal.api exposes the folder ../org.etsi.osl.portal.web/src/ in a folder testweb (Check class MvcConfig.java in org.etsi.osl.portal.api) for development. (In production nginx is used). Point your browser to `http://localhost:13000/osapi/testweb/index.html/`
The Web UI is written in AngularJS.
Clone the repository: https://labs.etsi.org/rep/osl/code/org.etsi.osl.portal.web/-/tree/develop
---
By default the project org.etsi.osl.portal.api exposes the folder ../org.etsi.osl.portal.web/src/ in a folder testweb (Check class MvcConfig.java in org.etsi.osl.portal.api) for development. (In production nginx is used). Point your browser to `http://localhost:13000/osapi/testweb/index.html/`
## Version/release management
Check this nice article on how we develop and release versions
Check this nice article on how we develop and release versions.
https://nvie.com/posts/a-successful-git-branching-model/
We develop in the develop branch
We develop in the develop branch and follow a issue driven development model.
---
## Wishlist
Check also our wishlist of new features. You can add your own
Check also our wishlist of new features. You can add your own.
See [Wishlist](./wishlist.md)
See [Wishlist](./wishlist.md).
......
doc/deployment.md
+ 391
− 313
View file @ 09b81acd
This diff is collapsed.
doc/images/favicon.png 0 → 100644
+ 0
− 0
View file @ 09b81acd
doc/images/favicon.png

822 B

doc/images/logo_osl.png 0 → 100644
+ 0
− 0
View file @ 09b81acd
doc/images/logo_osl.png

15.2 KiB

doc/images/logo_osl_square.png 0 → 100644
+ 0
− 0
View file @ 09b81acd
doc/images/logo_osl_square.png

63.1 KiB

doc/images/logo_osl_square_non_transp.png 0 → 100644
+ 0
− 0
View file @ 09b81acd
doc/images/logo_osl_square_non_transp.png

7.22 KiB

doc/images/openslice_logo.png
+ 0
− 0
View replaced file @ 864ecbe2 View file @ 09b81acd
doc/images/openslice_logo.png

29.3 KiB | W: | H:

doc/images/openslice_logo.png

16.2 KiB | W: | H:

doc/images/openslice_logo.png
doc/images/openslice_logo.png
doc/images/openslice_logo.png
doc/images/openslice_logo.png
  • 2-up
  • Swipe
  • Onion skin
doc/images/openslice_logo_old.png 0 → 100644
+ 0
− 0
View file @ 09b81acd
doc/images/openslice_logo_old.png

29.3 KiB

doc/index.md
+ 39
− 32
View file @ 09b81acd
<img src="images/openslice_logo.png" alt="drawing" width="200"/>
version: 2023-Q3 1.2.0-SNAPSHOT
version: 2023Q4 - Release 0
Openslice is a prototype open source, operations support system. It supports VNF/NSD onboarding to OpenSourceMANO (OSM) and NSD deployment management. It also supports TMFORUM OpenAPIs regarding Service Catalog Management, Ordering, Resource, etc.
The ETSI Software Development Group for OpenSlice (SDG OSL) is developing an open source service based Operations Support System (OSS) to deliver Network Slice as a Service (NSaaS) following specifications from major SDOs including ETSI, TM Forum and GSMA. See more details [here](https://osl.etsi.org/about/).
## Usage
Openslice allows Vertical Customers to browse the available offered service specifications and also allows NFV developers to onboard and manage VNF and Network Service artifacts.
The following figure displays the usage of Openslice.
OpenSlice allows Vertical Customers to browse the available offered service specifications and also allows NFV developers to onboard and manage VNF and Network Service artifacts. It also supports TMFORUM OpenAPIs regarding Service Catalog Management, Ordering, Resource, etc.
The following figure displays the usage of OpenSlice.
[![Openslice usage](./images/index_intro_architecture.png)](./images/index_intro_architecture.png)
[![OpenSlice usage](./images/index_intro_architecture.png)](./images/index_intro_architecture.png)
There are two portals offering UI friendly access to users:
......@@ -18,34 +18,34 @@ There are two portals offering UI friendly access to users:
* The Services portal allows users to access services and service providers to design services.
* The NFV portal allows users to self-manage NFV artifacts and onboard them to a target MANO/NFV Orchestrator.
3rd party applications can use Openslice through TMForum Open APIs.
3rd party applications can use OpenSlice through TMForum Open APIs.
Service Specifications reside into Service Catalogs, grouped in Categories. Openslice offers a Service Orchestrator called [OSOM](./architecture/osom.md). OSOM instantiates Service Specifications by requesting Network Services from target MANOs/NFVOs. NFV artifacts reside into a VNF/NSD catalog and are onboarded to a target MANO/NFV Orchestrator. Service Specifications reference NSD from the VNF/NSD catalog.
Service Specifications reside into Service Catalogs, grouped in Categories. OpenSlice offers a Service Orchestrator called [OSOM](./architecture/osom.md). OSOM instantiates Service Specifications by requesting Network Services from target MANOs/NFVOs. NFV artifacts reside into a VNF/NSD catalog and are onboarded to a target MANO/NFV Orchestrator. Service Specifications reference NSD from the VNF/NSD catalog.
Customers make Service Orders and Openslice instantiates the requested Service Specifications of the Service Order. Running Services instantiated by Openslice, reside in Openslice Service Inventory. The following picture displays how Service Specifications are related to Running Services and how Running Services relate with instantiated running Network Services. (See also [Service Inventory](./service_inventory.md) )
Customers make Service Orders and OpenSlice instantiates the requested Service Specifications of the Service Order. Running Services instantiated by OpenSlice, reside in OpenSlice Service Inventory. The following picture displays how Service Specifications are related to Running Services and how Running Services relate with instantiated running Network Services. (See also [Service Inventory](./service_inventory.md))
[![Openslice Service Specification instantiation](./images/service_specification_instantiation.png)](./images/service_specification_instantiation.png)
[![OpenSlice Service Specification instantiation](./images/service_specification_instantiation.png)](./images/service_specification_instantiation.png)
## Service Lifecycle Rules
Openslice constains support for defining rules of services, affecting their behavior. See [LCm Rules](./lcm.md)
OpenSlice constains support for defining rules of services, affecting their behavior. See [LCM Rules](./lcm.md).
## Multidomain scenarios and federation
Openslice can be used to exchange service specifications/catalogs and make service orders between Organizations as the following figure displays.
OpenSlice can be used to exchange service specifications/catalogs and make service orders between Organizations as the following figure displays.
[![Openslice Service Specification instantiation](./images/multi-domain-organizations.png)](./images/multi-domain-organizations.png)
[![OpenSlice Service Specification instantiation](./images/multi-domain-organizations.png)](./images/multi-domain-organizations.png)
An Identity federation is also possible since our authentication service is based on Keycloak (see [OAuth](./architecture/oauth.md) )
An Identity federation is also possible since our authentication service is based on Keycloak (see [OAuth](./architecture/oauth.md)).
See more on [Consuming Services From External Partner Organizations](./architecture/consumingServicesFromExternalPartners.md)
See more on [Consuming Services From External Partner Organizations](./architecture/consumingServicesFromExternalPartners.md).
## Live Demo
* Openslice demo: <http://portal.openslice.io/>
* Openslice Service Catalogs and ordering: <http://portal.openslice.io/services/>
* Openslice NFV Services onboarding: <http://portal.openslice.io/nfvportal>
* OpenSlice demo: <http://portal.openslice.io/>
* OpenSlice Service Catalogs and ordering: <http://portal.openslice.io/services/>
* OpenSlice NFV Services onboarding: <http://portal.openslice.io/nfvportal>
> username=admin, password=openslice <br> or <br>username=admin, password=changeme
......@@ -57,23 +57,26 @@ See more on [Consuming Services From External Partner Organizations](./architect
## Installing
See [Deployment/Installation](./deployment.md)
See [Deployment/Installation](./deployment.md).
---
## Hardware requirements
The complete environment consists of microservices deployed as docker containers. Portainer is also installed to monitor them at port 9000
The complete environment consists of microservices deployed as docker containers. Portainer is also installed to monitor them at port 9000.
If you would like to operate all APIs, OSOM, the Mysql Server, nginx, etc then you need at least:
- 4 cores
- 8GB RAM
- 20GB HD space
| **Minimum Hardware Requirements** | **Recomended Hardware Requirements** |
| --------------------------------- | ------------------------------------ |
| 4 CPU cores | 8 CPU cores |
| 8 GB RAM | 16 GB RAM |
| 20 GB storage | 40 GB storage |
(NOTE: Bugzilla or ELK are not included and we assume they run elsewhere)
However you can try with a minimum installation on a VM on a laptop with:
However, you may try the front facing services of OpenSlice with a minimum installation on a VM on a laptop with:
- 2 cores
- 4GB of RAM
......@@ -82,32 +85,36 @@ However you can try with a minimum installation on a VM on a laptop with:
## Supported APIs
For a quick access check our swagger links:
Quick overview of the supported APIs through our Swagger links:
* TMF APIs: <http://portal.openslice.io/tmf-api/swagger-ui/>
* API for VNF/NSD management: <http://portal.openslice.io/osapi/swagger-ui/l>
* [TMF APIs](http://portal.openslice.io/tmf-api/swagger-ui/index.html)
* [API for VNF/NSD management](http://portal.openslice.io/osapi/swagger-ui/index.html)
## Source code
Get source code here: <https://github.com/openslice>
OpenSlice source code is available at [OSL GitLab repository](https://labs.etsi.org/rep/osl/code).
## Contributing
[Contributing](./contributing/developing.md)
You may contribute following the guidelines at [Contributing page](./contributing/developing.md).
## Social Media
* Twitter: <https://twitter.com/OpensliceOSS>
* Slack: https://openslice.slack.com
* [Twitter](https://twitter.com/OpensliceOSS)
* [Slack](https://openslice.slack.com)
## History
* The NFV portal part of Openslice was initially developed in H2020 European project 5GinFIRE (https://5ginfire.eu) by University of Patras, Greece
* Openslice services, APIs and current version are actively maintained by University of Patras, Greece in H2020 European project 5G-VINNI (https://5g-vinni.eu/)
* The NFV portal part of OpenSlice was initially developed in H2020 European Research project [5GinFIRE](https://5ginfire.eu) by University of Patras, Greece
* OpenSlice core services, APIs was further developed and maintained in H2020 European project [5G-VINNI](https://5g-vinni.eu/) by University of Patras, Greece
* OpenSlice has been a part off OSM's OSS/BSS ecosystem
[![Part of OSM Ecosystem](./images/osm_ecosystem_ossbss.png)](https://osm.etsi.org/wikipub/index.php/OSS_BSS)
## Ecosystem
Discover the current OpenSlice ecosystem [here](https://osl.etsi.org/ecosystem/).
## Citation
......
mkdocs.yml
+ 41
− 22
View file @ 09b81acd
# Project information
site_name: Openslice
site_description: Openslice - Open source OSS - develop
site_author: Openslice.io
site_url: http://openslice.io
site_name: ETSI SDG OSL Documentation
site_description: ETSI SDG OSL Documentation page
site_author: OpenSlice by ETSI
site_url: https://osl.etsi.org/
# Repository
repo_name: openslice
repo_url: https://github.com/openslice
repo_name: OSL GitLab
repo_url: https://labs.etsi.org/rep/osl
edit_uri: ""
docs_dir: doc
......@@ -17,36 +17,55 @@ docs_dir: doc
# remote_branch: gh-pages
# Theme and overrides, i.e. language partial
# https://squidfunk.github.io/mkdocs-material/creating-your-site/
theme:
name: mkdocs
name: material
# Don't include MkDocs' JavaScript
include_search_page: false
search_index_only: true
#include_search_page: false
#search_index_only: true
# Default values, taken from mkdocs_theme.yml
language: en
feature:
tabs: true
# feature:
# tabs: true
features:
- navigation.instant
- navigation.instant.progress
- navigation.top
- navigation.footer
- navigation.path
- search
- search.highlight
palette:
primary: 'teal'
accent: 'light blue'
logo: 'images/openslice_logo.png'
primary: 'cyan'
accent: 'blue'
logo: 'images/logo_osl.png'
favicon: images/favicon.png
icon:
repo: fontawesome/brands/gitlab
# Copyright
copyright: "Copyright &copy; 2019-2023 Openslice Project"
copyright: "Copyright &copy; 2019-2024 Openslice Project"
# Options
extra:
search:
languages: "en"
# search:
# languages: "en"
social:
- type: globe
link: http://openslice.io
- type: github-alt
link: https://github.com/openslice
- type: twitter
- icon: fontawesome/solid/globe
link: https://osl.etsi.org/
- icon: fontawesome/brands/gitlab
link: https://labs.etsi.org/rep/osl
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/openslice/
- icon: fontawesome/brands/x-twitter
link: https://twitter.com/OpensliceOSS
version:
provider: mike
# Page tree
nav:
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please to comment