Loading doc/gettingstarted/howtorun.md +20 −11 Changes for doc/gettingstarted/howtorun.md: 20 added lines, 11 removed lines. Original line number Diff line number Diff line Loading @@ -28,6 +28,9 @@ Usage: ./run.sh [environment] [options] -v : Set OCF version of images -f : Services directory. (Default $SERVICES_DIR) -g : Gitlab base URL. (Default $REGISTRY_BASE_URL) -t : Number of retries for pulling base images. (Default 3) -d : Retry delay in seconds. (Default 5) -p : Pull base images with retries before building. Default TRUE -b : Build docker images. Default TRUE -h : show this help ``` Loading Loading @@ -144,19 +147,25 @@ python3 -m <service> ### Other Local Scripts Here there is a little explanation of each script present under services directory. All scripts have helm, you can run ./<any_script>.sh -h to show how to use. All scripts have help, you can run ./<any_script>.sh -h to show how to use. | Script | Description | | :--------------------------------- | :--------------------------------------------------------------------------------------------------- | | clean_mock_server.sh | This script is used to undeploy local mock server. | | :----------------------------------- | :--------------------------------------------------------------------------------------------------- | | check_architecture.sh | Check the CPU architecture of all Docker images present in the local registry. | | check_services_are_running.sh | Verify that all essential CAPIF services (Vault, CCF and Register) are running. | | clean_capif_docker_services.sh | Remove and clean CAPIF Docker services. Supports selective service removal via flags. | | clean_capif_temporary_files.sh | Clean temporary files generated by CAPIF services, monitoring, robot tests or docs. | | clean_mock_server.sh | Undeploy local mock server. | | create_users.sh | Create users at local deployment. | | populate_create_remote_dummy_users.sh | Create dummy providers and invokers for testing, publish service APIs and create security contexts. | | populate_remove_remote_dummy_users.sh | Remove dummy information created by populate_create_remote_dummy_users.sh. | | remove_users.sh | Delete users at local deployment. | | run_capif_tests.sh | Run Capif tests by using robot image. | | run_interconnection_environments.sh | Deploy locally two instances of OpenCAPIF. You must specify the envs to be used. | | run_capif_tests.sh | Run CAPIF tests using the robot Docker image. | | run_interconnection_environment.sh | Deploy locally two instances of OpenCAPIF with interconnection enabled. | | run_mock_server.sh | Deploy locally the mock server instance. | | run.sh | Deploy locally an OpenCAPIF Instance. | | show_logs.sh | Shows the logs of local deployed OpenCAPIF Services. | | variables.sh | This script just set default values to be used by local environment. Can be overridden by envs files. | | run.sh | Deploy locally an OpenCAPIF instance. | | show_logs.sh | Show the logs of locally deployed OpenCAPIF services. | | variables.sh | Set default values for the local environment. Can be overridden by env files. | #### Start Your Testing with OpenCAPIF Loading @@ -168,6 +177,6 @@ Related with OpenCAPIF Testing, the following sections help you to understand te - [Testing with Postman]: Easy way to understand the complete basic OpenCAPIF flow, acting as invoker and provider. [Test Plan Directory]: .././testplan/README.md "Test Plan" [Testing with Robot Framework]: .././testing/robotframework/README.md "Robot Framework" [Testing with Postman]: .././testing/postman/README.md "Postman" [Test Plan Directory]: ../testplan/README.md "Test Plan" [Testing with Robot Framework]: ../testing/robotframework/README.md "Robot Framework" [Testing with Postman]: ../testing/postman/README.md "Postman" Loading
doc/gettingstarted/howtorun.md +20 −11 Changes for doc/gettingstarted/howtorun.md: 20 added lines, 11 removed lines. Original line number Diff line number Diff line Loading @@ -28,6 +28,9 @@ Usage: ./run.sh [environment] [options] -v : Set OCF version of images -f : Services directory. (Default $SERVICES_DIR) -g : Gitlab base URL. (Default $REGISTRY_BASE_URL) -t : Number of retries for pulling base images. (Default 3) -d : Retry delay in seconds. (Default 5) -p : Pull base images with retries before building. Default TRUE -b : Build docker images. Default TRUE -h : show this help ``` Loading Loading @@ -144,19 +147,25 @@ python3 -m <service> ### Other Local Scripts Here there is a little explanation of each script present under services directory. All scripts have helm, you can run ./<any_script>.sh -h to show how to use. All scripts have help, you can run ./<any_script>.sh -h to show how to use. | Script | Description | | :--------------------------------- | :--------------------------------------------------------------------------------------------------- | | clean_mock_server.sh | This script is used to undeploy local mock server. | | :----------------------------------- | :--------------------------------------------------------------------------------------------------- | | check_architecture.sh | Check the CPU architecture of all Docker images present in the local registry. | | check_services_are_running.sh | Verify that all essential CAPIF services (Vault, CCF and Register) are running. | | clean_capif_docker_services.sh | Remove and clean CAPIF Docker services. Supports selective service removal via flags. | | clean_capif_temporary_files.sh | Clean temporary files generated by CAPIF services, monitoring, robot tests or docs. | | clean_mock_server.sh | Undeploy local mock server. | | create_users.sh | Create users at local deployment. | | populate_create_remote_dummy_users.sh | Create dummy providers and invokers for testing, publish service APIs and create security contexts. | | populate_remove_remote_dummy_users.sh | Remove dummy information created by populate_create_remote_dummy_users.sh. | | remove_users.sh | Delete users at local deployment. | | run_capif_tests.sh | Run Capif tests by using robot image. | | run_interconnection_environments.sh | Deploy locally two instances of OpenCAPIF. You must specify the envs to be used. | | run_capif_tests.sh | Run CAPIF tests using the robot Docker image. | | run_interconnection_environment.sh | Deploy locally two instances of OpenCAPIF with interconnection enabled. | | run_mock_server.sh | Deploy locally the mock server instance. | | run.sh | Deploy locally an OpenCAPIF Instance. | | show_logs.sh | Shows the logs of local deployed OpenCAPIF Services. | | variables.sh | This script just set default values to be used by local environment. Can be overridden by envs files. | | run.sh | Deploy locally an OpenCAPIF instance. | | show_logs.sh | Show the logs of locally deployed OpenCAPIF services. | | variables.sh | Set default values for the local environment. Can be overridden by env files. | #### Start Your Testing with OpenCAPIF Loading @@ -168,6 +177,6 @@ Related with OpenCAPIF Testing, the following sections help you to understand te - [Testing with Postman]: Easy way to understand the complete basic OpenCAPIF flow, acting as invoker and provider. [Test Plan Directory]: .././testplan/README.md "Test Plan" [Testing with Robot Framework]: .././testing/robotframework/README.md "Robot Framework" [Testing with Postman]: .././testing/postman/README.md "Postman" [Test Plan Directory]: ../testplan/README.md "Test Plan" [Testing with Robot Framework]: ../testing/robotframework/README.md "Robot Framework" [Testing with Postman]: ../testing/postman/README.md "Postman"
