diff --git a/doc/releasenotes.md b/doc/releasenotes.md index 99c3299b0eaf963cd92478afb9986a8040bbd3fd..b0a7aada77e9be8c1053d08b6088476eaac7637c 100644 --- a/doc/releasenotes.md +++ b/doc/releasenotes.md @@ -5,8 +5,8 @@ #### 3GPP CAPIF release 18 - New endpoints included in new release 18 with new logic. -- New logic to support Vendor Extensibility on Publish Service. -- New logic to support API Status feature on Publish and Events Services. +- New logic to support ***Vendor Extensibility*** on Publish Service. +- New logic to support ***API Status*** feature on Publish and Events Services. - Supported Features now are mandatory for all POST and PUT Requests as is described on TS 29.222. - **Possible Breaking change**, all POST request now must include supported features attribute, default can me set to "0" to keep all features inactive. - **Possible Breaking change** on Events API, if you need eventDetails information on notification you must activate **Enhanced Event Report** feature by setting properly the supported features flag. @@ -22,7 +22,7 @@ #### **Issues** -- Solved issue to gert ready REDIS on deployment: REDIS scheduled on start to allow receive notification since service is deployed. +- Solved issue to get ready REDIS on deployment: REDIS scheduled on start to allow receive notification since service is deployed. - Solved problem removing service APIs published is provider register more than one APF. - Solved Superadmin problem deleting service API published through helper service if provider is not present. - Increased the overall stability, fixing some corner cases. @@ -45,25 +45,29 @@ New scripts developed to help on remote deployment, configuration and testing. A ***variables.sh*** contains all configuration that will be used on remote operation. This file must be filled carefully before run remote scripts. - Deployment Scripts: - - ***install_vault.sh***: This script will configure and execute helm install of vault chart. This script also execute job to configure vault. - - ***install_monitoring.sh***: This script will configure and execute helm install of monitoring chart. - - ***install_capif.sh***: This script will configure and execute helm install of capif component chart. - - ***uninstall_vault.sh***: This script uninstall vault component from remote environment. - - ***uninstall_monitoring.sh***: This script uninstall monitoring components from remote environment. - - ***uninstall_capif.sh***: This script uninstall capif components from remote environment. + - ***install_vault.sh***: Deploy Vault component from k8s cluster, only needed if vault is not previously deployed. If it’s deployed you can setup vault token on variables.sh. + - ***install_monitoring.sh***: Deploy monitoring on k8s cluster. + - ***install_capif.sh***: Deploy OpenCAPIF on k8s cluster. It will be deployed on configured namespace with domain and hostnames configured under variables.sh. + - ***uninstall_vault.sh***: Rollback Vault component from k8s cluster. + - ***uninstall_monitoring.sh***: Rollback monitoring components from k8s cluster. + - ***uninstall_capif.sh***: Rollback OpenCAPIF from k8s cluster. - Manage remote users: - - ***create_remote_users.sh*** - - ***remove_remote_users.sh*** - - ***remove_remote_users_by_prefix.sh*** + - ***create_remote_users.sh***: This script create users setup by parameters on deployed OpenCAPIF. Those users are created by administrator. + - ***remove_remote_users.sh***: This script removes user from deployed OpenCAPIF. + - ***remove_remote_users_by_prefix.sh***:: This script removes users by prefix. + +- Configuration of bastion machine, this simplify DNS fixed resolution: + - ***get_ingress.sh***: This create a configuration for dns fixed resolution for ingress configured in namespace passed by parameters. + - ***set_ingress.sh***: This scripts adds to /etc/hosts the fixed DNS resolution for ingress setup for namespace passed by parameters. + - Execute robot tests over remote deployment. - - ***run_remote_capif_tests.sh*** + - ***run_remote_capif_tests.sh***: This scripts launch Robot Test docker image on current machine to reach deployed OpenCAPIF. Is useful to launch with “--include smoke†in order to ensure all is deployed properly. + +- Just for testing, next scripts upload dummy information to deployed OpenCAPIF: + - ***populate_create_remote_dummy_users.sh***: : Create Dummy providers and invokers, publish service APIs and creates security context for invokers. + - ***populate_remove_remote_dummy_users.sh***: Remove dummy information created. -- Other helpful scripts: - - ***get_ingress.sh***: returns all ingress of a k8s namespace with ip to put on /etc/hosts to have a fixed DNS local resolution. - - ***set_ingress.sh***: Is the same than get_ingress.sh but it also add those fixed dns local resolution to /etc/hosts - - ***populate_create_remote_dummy_users.sh***: This script is created mainly for testing remote deployment with dummy information, onboarding invokers, providers, publishing apis and creating security context for all of them. - - ***populate_remove_remote_dummy_users.sh***: This scripts remove all dummy information loaded. ### **Documentation**