openstack/tacker
Code Issues Proposed changes

Documentation improvements

Browse Source 
This patch improves the documentation for the following points:
  * Change location of supported k8s/helm/prometheus/alertmanager
    versions
  * Change location of `--os-tacker-api-version 2` in the CLI
    documentation
  * Change VIM status from `PENDING` and `REACHABLE` to `ACTIVE`
  * Change the description of `TACKER_ROOT`
  * Change `dsvm-compliance-sol-api` to `ft-v1-compliance-sol`
  * Add a description of the modules required for the VNF Package
    generation tools
  * Add a note regarding the output file of the VNF Package
    generation tools
  * Remove unnecessary spaces

Change-Id: I584e43ec3f093b0a3f63cf94bf441318ffd7fd21
This commit is contained in:
Ai Hamano 2024-12-03 15:35:41 +09:00
parent 7cb7070df4
commit 8e50a7dc0b
28 changed files with 314 additions and 260 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
api-ref/source/v1/samples/vims/vims-create-request.json
View File

@ -1,7 +1,7 @@
{
"vim": {
"type": "openstack",
"auth_url": "http://192.168.42.131/identity",
"auth_url": "http://192.168.56.10/identity",
"auth_cred": {
"username": "nfv_user",
"user_domain_name": "Default",
@ -12,8 +12,8 @@
"name": "nfv",
"project_domain_name": "Default"
},
"name": "VIM1",
"description": "Additional site",
"is_default": false
"name": "VIM0",
"description": "",
"is_default": true
}
}

49
api-ref/source/v1/samples/vims/vims-create-response.json
View File

@ -1,35 +1,36 @@
{
"vim": {
"status": "PENDING",
"description": "Additional site",
"tenant_id": "a5346a4d3c464b4f8776ee2f4bfb86af",
"created_at": "2018-06-18 04:13:26.465823",
"vim_project": {
"name": "nfv",
"project_domain_name": "Default"
"auth_cred": {
"auth_url": "http://192.168.56.10/identity/v3",
"cert_verify": "True",
"key_type": "barbican_key",
"password": "***",
"project_domain_name": "Default",
"project_id": null,
"project_name": "nfv",
"secret_uuid": "***",
"user_domain_name": "Default",
"username": "nfv_user"
},
"updated_at": null,
"is_default": false,
"auth_url": "http://192.168.42.131/identity/v3",
"auth_url": "http://192.168.56.10/identity/v3",
"created_at": "2024-12-03 08:17:28.513225",
"description": "",
"extra": {},
"id": "ac65f86a-eece-4ab3-9be3-483d09189c7f",
"is_default": true,
"name": "VIM0",
"placement_attr": {
"regions": [
"RegionOne"
]
},
"auth_cred": {
"username": "nfv_user",
"password": "***",
"project_name": "nfv",
"cert_verify": "True",
"user_domain_name": "Default",
"auth_url": "http://192.168.42.131/identity/v3",
"project_id": null,
"key_type": "barbican_key",
"secret_uuid": "***",
"project_domain_name": "Default"
},
"status": "ACTIVE",
"tenant_id": "875c2bf1627b4b22a7f3c8c0cae5efda",
"type": "openstack",
"id": "28dbc4f0-80e2-4006-b26c-724a1202e82d",
"name": "VIM1"
"updated_at": null,
"vim_project": {
"name": "nfv",
"project_domain_name": "Default"
}
}
}

47
api-ref/source/v1/samples/vims/vims-list-response.json
View File

@ -1,37 +1,38 @@
{
"vims": [
{
"status": "REACHABLE",
"description": "",
"tenant_id": "a5346a4d3c464b4f8776ee2f4bfb86af",
"created_at": "2018-06-17 16:26:52",
"vim_project": {
"name": "nfv",
"project_domain_name": "Default"
"auth_cred": {
"auth_url": "http://192.168.56.10/identity/v3",
"cert_verify": "False",
"key_type": "barbican_key",
"password": "***",
"project_domain_name": "Default",
"project_id": null,
"project_name": "nfv",
"secret_uuid": "***",
"user_domain_name": "Default",
"username": "nfv_user"
},
"updated_at": "2018-06-18 03:45:49",
"auth_url": "http://192.168.56.10/identity/v3",
"created_at": "2024-12-03 05:19:49",
"description": "",
"extra": {},
"id": "fd8a3ac0-8e61-4740-a021-8fa35d833635",
"is_default": true,
"auth_url": "http://192.168.42.131/identity/v3",
"name": "VIM0",
"placement_attr": {
"regions": [
"RegionOne"
]
},
"auth_cred": {
"username": "nfv_user",
"password": "***",
"project_name": "nfv",
"cert_verify": "True",
"user_domain_name": "Default",
"auth_url": "http://192.168.42.131/identity/v3",
"project_id": null,
"key_type": "barbican_key",
"secret_uuid": "***",
"project_domain_name": "Default"
},
"status": "ACTIVE",
"tenant_id": "875c2bf1627b4b22a7f3c8c0cae5efda",
"type": "openstack",
"id": "cb7ac02e-1445-48c2-a3cb-4fcddd49fce5",
"name": "VIM0"
"updated_at": null,
"vim_project": {
"name": "nfv",
"project_domain_name": "Default"
}
}
]
}

49
api-ref/source/v1/samples/vims/vims-show-response.json
View File

@ -1,35 +1,36 @@
{
"vim": {
"status": "REACHABLE",
"description": "",
"tenant_id": "a5346a4d3c464b4f8776ee2f4bfb86af",
"created_at": "2018-06-17 16:26:52",
"vim_project": {
"name": "nfv",
"project_domain_name": "Default"
"auth_cred": {
"auth_url": "http://192.168.56.10/identity/v3",
"cert_verify": "False",
"key_type": "barbican_key",
"password": "***",
"project_domain_name": "Default",
"project_id": null,
"project_name": "nfv",
"secret_uuid": "***",
"user_domain_name": "Default",
"username": "nfv_user"
},
"updated_at": "2018-06-18 03:45:49",
"is_default": false,
"auth_url": "http://192.168.42.131/identity/v3",
"auth_url": "http://192.168.56.10/identity/v3",
"created_at": "2024-12-03 05:19:49",
"description": "",
"extra": {},
"id": "fd8a3ac0-8e61-4740-a021-8fa35d833635",
"is_default": true,
"name": "VIM0",
"placement_attr": {
"regions": [
"RegionOne"
]
},
"auth_cred": {
"username": "nfv_user",
"password": "***",
"project_id": null,
"project_name": "nfv",
"cert_verify": "True",
"user_domain_name": "Default",
"key_type": "barbican_key",
"secret_uuid": "***",
"auth_url": "http://192.168.42.131/identity/v3",
"project_domain_name": "Default"
},
"status": "ACTIVE",
"tenant_id": "875c2bf1627b4b22a7f3c8c0cae5efda",
"type": "openstack",
"id": "cb7ac02e-1445-48c2-a3cb-4fcddd49fce5",
"name": "VIM0"
"updated_at": null,
"vim_project": {
"name": "nfv",
"project_domain_name": "Default"
}
}
}

49
api-ref/source/v1/samples/vims/vims-update-response.json
View File

@ -1,35 +1,36 @@
{
"vim": {
"status": "REACHABLE",
"description": "New Description",
"tenant_id": "a5346a4d3c464b4f8776ee2f4bfb86af",
"created_at": "2018-06-18 04:13:26",
"vim_project": {
"auth_cred": {
"auth_url": "http://192.168.56.10/identity/v3",
"cert_verify": "True",
"key_type": "barbican_key",
"password": "***",
"project_domain_name": "NewDomain",
"name": "new_nfv"
}
"updated_at": "2018-06-18 04:33:41.462895",
"is_default": false,
"auth_url": "http://192.168.42.131/identity/v3",
"project_id": null,
"project_name": "new_nfv",
"secret_uuid": "***",
"user_domain_name": "NewDomain",
"username": "new_nfv_user"
},
"auth_url": "http://192.168.56.10/identity/v3",
"created_at": "2024-12-03 05:19:49",
"description": "New Description",
"extra": {},
"id": "fd8a3ac0-8e61-4740-a021-8fa35d833635",
"is_default": true,
"name": "new_VIM0",
"placement_attr": {
"regions": [
"RegionOne"
]
},
"auth_cred": {
"username": "new_nfv_user",
"password": "***",
"project_id": null,
"project_name": "new_nfv",
"user_domain_name": "NewDomain",
"auth_url": "http://192.168.42.131/identity/v3",
"project_domain_name": "NewDomain",
"cert_verify": "True",
"key_type": "barbican_key",
"secret_uuid": "***"
},
"status": "ACTIVE",
"tenant_id": "875c2bf1627b4b22a7f3c8c0cae5efda",
"type": "openstack",
"id": "28dbc4f0-80e2-4006-b26c-724a1202e82d",
"name": "new_VIM1"
"updated_at": "2024-12-03 05:49:54.671415",
"vim_project": {
"name": "new_nfv",
"project_domain_name": "NewDomain"
}
}
}

2
doc/source/admin/kubernetes_openid_token_auth_usage_guide.rst
View File

@ -237,7 +237,7 @@ Get a OpenID token from Keycloak:
.. code-block:: console
$ ID_TOKEN=$(curl -ks -X POST https://192.168.2.33:8443/realms/oidc/protocol/openid-connect/token \
-d grant_type=password -d scope=openid -d username=end-user -d password=end-user \
-d grant_type=password -d scope=openid -d username=end-user -d password=end-user \
-d client_id=tacker -d client_secret=A93HfOUpySm6BjPug9PJdJumjEGUJMhc | jq -r .id_token)
$ echo $ID_TOKEN

2
doc/source/cli/cli-etsi-vnffm.rst
View File

@ -152,7 +152,7 @@ Help:
.. code-block:: console
$ openstack vnffm alarm show --os-tacker-api-version 2 --help
$ openstack vnffm alarm show --os-tacker-api-version 2 --help
usage: openstack vnffm alarm show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--noindent] [--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty]

89
doc/source/cli/v2/vnflcm.rst
View File

@ -42,7 +42,7 @@ The `VNFD_ID` should be replaced with the VNFD ID in VNF Package.
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 create VNFD_ID
$ openstack vnflcm create VNFD_ID --os-tacker-api-version 2
Result:
@ -77,7 +77,7 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 create --help
$ openstack vnflcm create --os-tacker-api-version 2 --help
usage: openstack vnflcm create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--noindent] [--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty] [--name <vnf-instance-name>]
@ -136,8 +136,8 @@ that will be used to instantiate VNF, respectively.
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 instantiate VNF_INSTANCE_ID \
SAMPLE_PARAM_FILE.json
$ openstack vnflcm instantiate VNF_INSTANCE_ID SAMPLE_PARAM_FILE.json \
--os-tacker-api-version 2
Result:
@ -151,7 +151,7 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 instantiate --help
$ openstack vnflcm instantiate --os-tacker-api-version 2 --help
usage: openstack vnflcm instantiate [-h] <vnf-instance> <param-file>
Instantiate a VNF Instance
@ -172,7 +172,7 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 list
$ openstack vnflcm list --os-tacker-api-version 2
Result:
@ -190,7 +190,7 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 list --help
$ openstack vnflcm list --os-tacker-api-version 2 --help
usage: openstack vnflcm list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--quote {all,minimal,none,nonnumeric}] [--noindent]
[--max-width <integer>] [--fit-width] [--print-empty]
@ -239,7 +239,7 @@ The `VNF_INSTANCE_ID` should be replaced with the ID of VNF instance.
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 show VNF_INSTANCE_ID
$ openstack vnflcm show VNF_INSTANCE_ID --os-tacker-api-version 2
Result:
@ -373,7 +373,7 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 show --help
$ openstack vnflcm show --os-tacker-api-version 2 --help
usage: openstack vnflcm show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--noindent] [--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty]
@ -423,7 +423,7 @@ The `VNF_INSTANCE_ID` should be replaced with the ID of VNF instance.
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 terminate VNF_INSTANCE_ID
$ openstack vnflcm terminate VNF_INSTANCE_ID --os-tacker-api-version 2
Result:
@ -437,7 +437,7 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 terminate --help
$ openstack vnflcm terminate --os-tacker-api-version 2 --help
usage: openstack vnflcm terminate [-h] [--termination-type <termination-type>]
[--graceful-termination-timeout <graceful-termination-timeout>]
[--D]
@ -469,7 +469,7 @@ The `VNF_INSTANCE_ID` should be replaced with the ID of VNF instance.
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 delete VNF_INSTANCE_ID
$ openstack vnflcm delete VNF_INSTANCE_ID --os-tacker-api-version 2
Result:
@ -483,7 +483,7 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 delete --help
$ openstack vnflcm delete --os-tacker-api-version 2 --help
usage: openstack vnflcm delete [-h] <vnf-instance> [<vnf-instance> ...]
Delete VNF Instance(s)
@ -505,7 +505,7 @@ The `VNF_INSTANCE_ID` should be replaced with the ID of VNF instance.
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 heal VNF_INSTANCE_ID
$ openstack vnflcm heal VNF_INSTANCE_ID --os-tacker-api-version 2
.. note::
@ -526,7 +526,7 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 heal --help
$ openstack vnflcm heal --os-tacker-api-version 2 --help
usage: openstack vnflcm heal [-h] [--cause CAUSE]
[--vnfc-instance <vnfc-instance-id> [<vnfc-instance-id> ...]]
[--additional-param-file <additional-param-file>]
@ -559,7 +559,8 @@ that will be used to update VNF, respectively.
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 update VNF_INSTANCE_ID --I SAMPLE_PARAM_FILE.json
$ openstack vnflcm update VNF_INSTANCE_ID --I SAMPLE_PARAM_FILE.json \
--os-tacker-api-version 2
Result:
@ -573,7 +574,7 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 update --help
$ openstack vnflcm update --os-tacker-api-version 2 --help
usage: openstack vnflcm update [-h] [--I <param-file>] <vnf-instance>
Update VNF Instance
@ -599,8 +600,8 @@ See 'How to Identify ASPECT_ID' in :doc:`/user/v2/vnf/scale/index` for details.
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 scale --type SCALE_OUT --aspect-id WORKER_INSTANCE \
VNF_INSTANCE_ID
$ openstack vnflcm scale --type SCALE_OUT --aspect-id WORKER_INSTANCE \
VNF_INSTANCE_ID --os-tacker-api-version 2
Result:
@ -614,7 +615,7 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 scale --help
$ openstack vnflcm scale --os-tacker-api-version 2 --help
usage: openstack vnflcm scale [-h] [--number-of-steps <number-of-steps>]
[--additional-param-file <additional-param-file>] --type
<type> --aspect-id <aspect-id>
@ -657,8 +658,8 @@ that will be used to change external VNF connectivity, respectively.
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 change-ext-conn VNF_INSTANCE_ID \
SAMPLE_PARAM_FILE.json
$ openstack vnflcm change-ext-conn VNF_INSTANCE_ID SAMPLE_PARAM_FILE.json \
--os-tacker-api-version 2
Result:
@ -672,7 +673,7 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 change-ext-conn --help
$ openstack vnflcm change-ext-conn --os-tacker-api-version 2 --help
usage: openstack vnflcm change-ext-conn [-h] <vnf-instance> <param-file>
Change External VNF Connectivity
@ -703,8 +704,8 @@ to change VNF Package of VNF instance, respectively.
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 change-vnfpkg VNF_INSTANCE_ID \
SAMPLE_PARAM_FILE.json
$ openstack vnflcm change-vnfpkg VNF_INSTANCE_ID SAMPLE_PARAM_FILE.json \
--os-tacker-api-version 2
Result:
@ -718,7 +719,7 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 change-vnfpkg --help
$ openstack vnflcm change-vnfpkg --os-tacker-api-version 2 --help
usage: openstack vnflcm change-vnfpkg [-h] <vnf-instance> <param-file>
Change Current VNF Package
@ -742,7 +743,7 @@ lifecycle management operation temporary failed.
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 op rollback VNF_LCM_OP_OCC_ID
$ openstack vnflcm op rollback VNF_LCM_OP_OCC_ID --os-tacker-api-version 2
Result:
@ -756,7 +757,7 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 op rollback --help
$ openstack vnflcm op rollback --os-tacker-api-version 2 --help
usage: openstack vnflcm op rollback [-h] <vnf-lcm-op-occ-id>
positional arguments:
@ -777,7 +778,7 @@ lifecycle management operation temporary failed.
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 op retry VNF_LCM_OP_OCC_ID
$ openstack vnflcm op retry VNF_LCM_OP_OCC_ID --os-tacker-api-version 2
Result:
@ -791,7 +792,7 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 op retry --help
$ openstack vnflcm op retry --os-tacker-api-version 2 --help
usage: openstack vnflcm op retry [-h] <vnf-lcm-op-occ-id>
Retry VNF Instance
@ -814,7 +815,7 @@ lifecycle management operation temporary failed.
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 op fail VNF_LCM_OP_OCC_ID
$ openstack vnflcm op fail VNF_LCM_OP_OCC_ID --os-tacker-api-version 2
Result:
@ -865,7 +866,7 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 op fail --help
$ openstack vnflcm op fail --os-tacker-api-version 2 --help
usage: openstack vnflcm op fail [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--noindent] [--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty]
@ -913,7 +914,7 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 op list
$ openstack vnflcm op list --os-tacker-api-version 2
Result:
@ -931,7 +932,7 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 op list --help
$ openstack vnflcm op list --os-tacker-api-version 2 --help
usage: openstack vnflcm op list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--quote {all,minimal,none,nonnumeric}] [--noindent]
[--max-width <integer>] [--fit-width] [--print-empty]
@ -989,7 +990,7 @@ lifecycle management operation.
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 op show VNF_LCM_OP_OCC_ID
$ openstack vnflcm op show VNF_LCM_OP_OCC_ID --os-tacker-api-version 2
Result:
@ -1075,7 +1076,7 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 op show --help
$ openstack vnflcm op show --os-tacker-api-version 2 --help
usage: openstack vnflcm op show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--noindent] [--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty]
@ -1126,7 +1127,7 @@ json file that will be used to create Lccn subscription.
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 subsc create SAMPLE_PARAM_FILE.json
$ openstack vnflcm subsc create SAMPLE_PARAM_FILE.json --os-tacker-api-version 2
Result:
@ -1277,7 +1278,7 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 subsc create --help
$ openstack vnflcm subsc create --os-tacker-api-version 2 --help
usage: openstack vnflcm subsc create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--noindent] [--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty]
@ -1324,7 +1325,7 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 subsc list
$ openstack vnflcm subsc list --os-tacker-api-version 2
Result:
@ -1342,7 +1343,7 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 subsc list --help
$ openstack vnflcm subsc list --os-tacker-api-version 2 --help
usage: openstack vnflcm subsc list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--quote {all,minimal,none,nonnumeric}] [--noindent]
[--max-width <integer>] [--fit-width] [--print-empty]
@ -1394,7 +1395,7 @@ The `LCCN_SUBSCRIPTION_ID` should be replaced with the ID of Lccn subscription.
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 subsc show LCCN_SUBSCRIPTION_ID
$ openstack vnflcm subsc show LCCN_SUBSCRIPTION_ID --os-tacker-api-version 2
Result:
@ -1545,7 +1546,7 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 subsc show --help
$ openstack vnflcm subsc show --os-tacker-api-version 2 --help
usage: openstack vnflcm subsc show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--noindent] [--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty]
@ -1595,7 +1596,7 @@ The `LCCN_SUBSCRIPTION_ID` should be replaced with the ID of Lccn subscription.
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 delete LCCN_SUBSCRIPTION_ID
$ openstack vnflcm subsc delete LCCN_SUBSCRIPTION_ID --os-tacker-api-version 2
Result:
@ -1609,7 +1610,7 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 subsc delete --help
$ openstack vnflcm subsc delete --os-tacker-api-version 2 --help
usage: openstack vnflcm subsc delete [-h] <subscription-id> [<subscription-id> ...]
Delete Lccn Subscription(s)

2
doc/source/configuration/policy-concepts.rst
View File

@ -56,7 +56,7 @@ in tokens. Token scopes represent the layer of authorization. Policy
.. note::
The ``scope_type`` of each policy is hardcoded to ``project`` scoped
The ``scope_type`` of each policy is hardcoded to ``project`` scoped
and is not overridable via the policy file.
Tacker policies have implemented the scope concept by defining the

8
doc/source/contributor/tacker_compliance_test.rst
View File

@ -173,7 +173,7 @@ To change the version execute the below steps:
1. Open ``<tacker_route_directory>/tacker/tox.ini`` file in any editor.
2. Under [testenv:dsvm-compliance-sol-api] section in **commands_pre** while
2. Under [testenv:ft-v1-compliance-sol] section in **commands_pre** while
doing checkout of api-tests mention desired TST's code version.
.. code-block:: console
@ -217,14 +217,14 @@ Execution of testcase
.. code-block:: console
tox -e dsvm-compliance-sol-api
tox -e ft-v1-compliance-sol
* Or from tacker directory, specific testcases can be executed using
the following command:
.. code-block:: console
tox -e dsvm-compliance-sol-api tacker.tests.compliance.xxx.yyy.<testcase>
tox -e ft-v1-compliance-sol tacker.tests.compliance.xxx.yyy.<testcase>
How to proceed when the test fails
@ -237,7 +237,7 @@ How to proceed when the test fails
.. code-block:: console
tacker/.tox/dsvm-compliance-sol-api/log/SOL003/VNFLifecycleManagement-API
tacker/.tox/ft-v1-compliance-sol/log/SOL003/VNFLifecycleManagement-API
/VNFInstances/GET_information_about_multiple_VNF_instances
* Compliance test may also get failed due to code problem at

12
doc/source/install/kubernetes_vim_installation.rst
View File

@ -400,7 +400,7 @@ It deploys VMs and Kubernetes resources on the same network.
| | ] |
| | } |
| project_id | 8cd3cc798ae14227a84f7b50c5ef984a |
| status | PENDING |
| status | ACTIVE |
| type | kubernetes |
| updated_at | None |
| vim_project | { |
@ -423,11 +423,11 @@ It deploys VMs and Kubernetes resources on the same network.
.. code-block:: console
+--------------------------------------+----------------+----------------------------------+------------+------------+-----------+
| ID | Name | Tenant_id | Type | Is Default | Status |
+--------------------------------------+----------------+----------------------------------+------------+------------+-----------+
| 884ec305-c8ca-47ef-8cba-fafceabeda30 | vim-kubernetes | 8cd3cc798ae14227a84f7b50c5ef984a | kubernetes | False | REACHABLE |
+--------------------------------------+----------------+----------------------------------+------------+------------+-----------+
+--------------------------------------+----------------+----------------------------------+------------+------------+--------+
| ID | Name | Tenant_id | Type | Is Default | Status |
+--------------------------------------+----------------+----------------------------------+------------+------------+--------+
| 884ec305-c8ca-47ef-8cba-fafceabeda30 | vim-kubernetes | 8cd3cc798ae14227a84f7b50c5ef984a | kubernetes | False | ACTIVE |
+--------------------------------------+----------------+----------------------------------+------------+------------+--------+
You can update those VIM information with :command:`openstack vim set`:

30
doc/source/reference/gen_vnf_pkg.rst
View File

@ -78,13 +78,12 @@ This tool support the following VIM Types:
* ETSINFV.KUBERNETES.V_1
* ETSINFV.HELM.V_3
In this document, TACKER_ROOT is the root of tacker's repository.
In this document, ``TACKER_ROOT`` is the root of tacker's repository on
the server.
.. code-block:: console
$ python3 -m pip install TAKCER_ROOT
$ export PYTHONPATH=TAKCER_ROOT
$ cd TAKCER_ROOT/tools
$ cd TACKER_ROOT/tools
$ python3 gen_vnf_pkg.py -h
usage: gen_vnf_pkg.py [-h] -t VIM_TYPE
@ -99,6 +98,19 @@ In this document, TACKER_ROOT is the root of tacker's repository.
* ETSINFV.HELM.V_3
.. note::
This tool requires some Tacker modules, so you need to run it in
an environment where Tacker is installed.
If you have installed Tacker in python virtual environment using devstack,
etc., please activate it as follows before using the tool.
.. code-block:: console
$ source ~/data/venv/bin/activate
(venv) $ python3 gen_vnf_pkg.py -h
The output of this tool is as follows:
* Specified VIM Type
@ -233,6 +245,14 @@ for each VIM Type under the output directory.
helm_terminate_req test_helm_instantiate.zip
.. note::
If a file exists with the same name as the zip file being generated,
the tool will fail.
When running the tool again to generate a zip file,
please delete or rename the old zip file.
For the following request files, ``endpoint``, ``ssl_ca_cert`` and
``bearer_token`` need to be changed by your own k8s cluster information.
@ -251,7 +271,7 @@ For the following request files, ``endpoint``, ``ssl_ca_cert`` and
You can also set your own k8s cluster information to ``auth_url``,
``barere_token``, and ``ssl_ca_cert`` in gen_vnf_pkg.py before running this tool.
``bearer_token``, and ``ssl_ca_cert`` in gen_vnf_pkg.py before running this tool.
.. note::

17
doc/source/user/architecture.rst
View File

@ -103,6 +103,23 @@ Change current VNF package complies with `ETSI NFV-SOL002 3.6.1`_.
supported by Tacker Horizon.
Supported versions:
[2024.1 Caracal / 2024.2 Dalmatian]
* **Kubernetes 1.26** - is supported from 2023.2 Bobcat to 2024.2 Dalmatian.
* **Helm 3.11** - is supported from 2023.2 Bobcat to 2024.2 Dalmatian.
* **Prometheus 2.45** - is supported from 2023.2 Bobcat onwards.
* **Alertmanager 0.26** - is supported from 2023.2 Bobcat onwards.
[2025.1 Epoxy]
* **Kubernetes 1.30** - is supported from 2025.1 Epoxy onwards.
* **Helm 3.15** - is supported from 2025.1 Epoxy onwards.
* **Prometheus 2.45** - is supported from 2023.2 Bobcat onwards.
* **Alertmanager 0.26** - is supported from 2023.2 Bobcat onwards.
Tacker Service
--------------

2
doc/source/user/encrypt_vim_auth_with_barbican.rst
View File

@ -108,7 +108,7 @@ Create a vim and verify it works:
| is_default | False |
| name | vim-test |
| placement_attr | {"regions": ["RegionOne"]} |
| status | REACHABLE |
| status | ACTIVE |
| tenant_id | 28a525feaf5e4d05b4ab9f7090837964 |
| type | openstack |
| updated_at | |

16
doc/source/user/etsi_containerized_vnf_usage_guide.rst
View File

@ -11,6 +11,10 @@ in Tacker v1 API using Kubernetes VIM.
See :doc:`/user/v2/cnf/deployment/index` for Tacker v2 API.
See :doc:`/user/architecture` for information about supported versions
of Kubernetes.
Overview
--------
@ -1142,18 +1146,6 @@ VNF instance deletion is successful.
Can not find requested vnf instance: 30d7c432-8ad3-4b05-81df-c5c7f340c62b
Supported versions
------------------
Tacker Antelope release
- Kubernetes: 1.25
Tacker Bobcat release
- Kubernetes: 1.26
.. _kubernetes_api_resource: https://opendev.org/openstack/tacker/src/branch/master/tacker/tests/unit/vnfm/infra_drivers/kubernetes/kubernetes_api_resource
.. _DNS Subdomain Names: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names
.. _OpenID Connect Tokens: https://kubernetes.io/docs/reference/access-authn-authz/authentication/#openid-connect-tokens

13
doc/source/user/etsi_getting_started.rst
View File

@ -23,7 +23,7 @@ Summary
This lecture enables you to:
- create & delete a sample VNF on the OpenStack with Tacker v1 API
- create & delete a sample VNF on the OpenStack with Tacker v1 API
.. note::
@ -553,14 +553,15 @@ Instantiate VNF
Required parameter:
- flavourID
- flavourId
Optional parametes:
- instantiationLevelId
- extVirtualLinks
- extManagedVirtualLinks
- vimConnectionInfo
- instantiationLevelId
- extVirtualLinks
- extManagedVirtualLinks
- vimConnectionInfo
- additionalParams
.. note::

8
doc/source/user/etsi_vnf_deployment_as_vm_with_tosca.rst
View File

@ -112,6 +112,8 @@ The VNF Package(sample_vnf_package_csar.zip) used below is prepared
by referring to :doc:`/user/vnf-package`.
As an example, you can create a VNF Package as follow.
In this document, ``TACKER_ROOT`` is the root of tacker's repository on
the server.
.. code-block:: console
@ -136,12 +138,6 @@ As an example, you can create a VNF Package as follow.
drwxr-xr-x 2 stack stack 4096 Dec 21 07:41 TOSCA-Metadata/
.. note::
In this document, ``TACKER_ROOT`` is the root of tacker's repository on
the server.
After you have done the above, you will have the sample VNF package
`sample_vnf_package_csar.zip`.

14
doc/source/user/mgmt_driver_deploy_k8s_and_cnf_with_helm.rst
View File

@ -238,17 +238,17 @@ You can refer to the `Register Kubernetes VIM`_ section to register VIM.
3. Confirm VIM status
~~~~~~~~~~~~~~~~~~~~~
For the registered VIM information, confirm that the VIM exists and
the Status is "REACHABLE".
the Status is "ACTIVE".
.. code-block:: console
$ openstack vim list
+--------------------------------------+-----------------------------+----------------------------------+------------+------------+-------------+
| ID | Name | Tenant_id | Type | Is Default | Status |
+--------------------------------------+-----------------------------+----------------------------------+------------+------------+-------------+
| 690edc6b-7581-48d8-9ac9-910c2c3d7c02 | kubernetes_vim_complex_helm | 7e757a0cfea940dab100216036212a65 | kubernetes | False | REACHABLE |
| 8343f55f-6bdf-4c5f-91c4-f6dd145c616d | VIM0 | 7e757a0cfea940dab100216036212a65 | openstack | True | REACHABLE |
+--------------------------------------+-----------------------------+----------------------------------+------------+------------+-------------+
+--------------------------------------+-----------------------------+----------------------------------+------------+------------+--------+
| ID | Name | Tenant_id | Type | Is Default | Status |
+--------------------------------------+-----------------------------+----------------------------------+------------+------------+--------+
| 690edc6b-7581-48d8-9ac9-910c2c3d7c02 | kubernetes_vim_complex_helm | 7e757a0cfea940dab100216036212a65 | kubernetes | False | ACTIVE |
| 8343f55f-6bdf-4c5f-91c4-f6dd145c616d | VIM0 | 7e757a0cfea940dab100216036212a65 | openstack | True | ACTIVE |
+--------------------------------------+-----------------------------+----------------------------------+------------+------------+--------+
Prepare VNF Package
^^^^^^^^^^^^^^^^^^^

2
doc/source/user/mgmt_driver_deploy_k8s_usage_guide.rst
View File

@ -264,7 +264,7 @@ cli command:
.. code-block:: console
$ auth='--os-username nfv_user --os-project-name nfv --os-password devstack --os-auth-url http://127.0.0.1/identity --os-project-domain-name Default --os-user-domain-name Default'
$ auth='--os-username nfv_user --os-project-name nfv --os-password devstack --os-auth-url http://127.0.0.1/identity --os-project-domain-name Default --os-user-domain-name Default'
$ nfv_project_id=`openstack project list $auth | grep -w '| nfv' | awk '{print $2}'`
$ default_id=`openstack security group list $auth | grep -w 'default' | grep $nfv_project_id | awk '{print $2}'`

8
doc/source/user/mgmt_driver_for_container_update.rst
View File

@ -98,12 +98,8 @@ How to Instantiate VNF for Updating
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can use the sample VNF package below to instantiate VNF to be updated.
.. note::
In this document, ``TACKER_ROOT`` is the root of tacker's repository on
the server.
In this document, ``TACKER_ROOT`` is the root of tacker's repository on
the server.
.. code-block:: console

39
doc/source/user/v2/cnf/deployment/index.rst
View File

@ -13,6 +13,10 @@ in Tacker v2 API using Kubernetes VIM.
* `test_instantiate_cnf_resources for 2023.2 Bobcat`_
See :doc:`/user/architecture` for information about supported versions
of Kubernetes.
Overview
--------
@ -233,11 +237,11 @@ Prepare VNF Package
-------------------
As an example, you can create a VNF Package as follow.
In this document, ``TACKER_ROOT`` is the root of tacker's repository on
the server.
.. code-block:: console
$ python3 -m pip install TACKER_ROOT
$ export PYTHONPATH=TACKER_ROOT
$ cd TACKER_ROOT/samples/tests/functional/sol_kubernetes_v2/test_instantiate_cnf_resources
$ python3 pkggen.py
$ ll
@ -250,13 +254,28 @@ As an example, you can create a VNF Package as follow.
.. note::
In this document, ``TACKER_ROOT`` is the root of tacker's repository on
the server.
This tool requires some Tacker modules, so you need to run it in
an environment where Tacker is installed.
If you have installed Tacker in python virtual environment using devstack,
etc., please activate it as follows before using the tool.
.. code-block:: console
$ source /opt/stack/data/venv/bin/activate
(venv) $ python3 pkggen.py
After you have done the above, you will have the sample VNF package
`test_instantiate_cnf_resources.zip`.
.. note::
If a file exists with the same name as the zip file being generated,
the tool will fail.
When running the tool again to generate a zip file,
please delete or rename the old zip file.
You can also create a VNF Package manually by following the steps.
@ -1012,18 +1031,6 @@ VNF instance deletion is successful.
VnfInstance 431b94b5-d7ba-4d1c-aa26-ecec65d7ee53 not found.
Supported versions
------------------
Tacker Antelope release
- Kubernetes: 1.25
Tacker Bobcat release
- Kubernetes: 1.26
.. _Kubernetes API resource: https://opendev.org/openstack/tacker/src/branch/master/tacker/tests/unit/vnfm/infra_drivers/kubernetes/kubernetes_api_resource
.. _DNS Subdomain Names: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names
.. _OpenID Connect Tokens: https://kubernetes.io/docs/reference/access-authn-authz/authentication/#openid-connect-tokens

16
doc/source/user/v2/cnf/deployment_using_helm/index.rst
View File

@ -21,6 +21,10 @@ using Helm in Tacker v2 API.
* `test_helm_instantiate for 2023.2 Bobcat`_
See :doc:`/user/architecture` for information about supported versions
of Helm.
Overview
--------
@ -1174,17 +1178,5 @@ we can append ``-A`` to the command line.
in the corresponding namespace.
Supported versions
------------------
Tacker Antelope release
- Helm: 3.10
Tacker Bobcat release
- Helm: 3.11
.. _test_helm_instantiate for 2023.2 Bobcat:
https://opendev.org/openstack/tacker/src/branch/stable/2023.2/tacker/tests/functional/sol_kubernetes_v2/samples/test_helm_instantiate

23
doc/source/user/v2/cnf/update_with_mgmt_driver/index.rst
View File

@ -87,11 +87,11 @@ How to Instantiate VNF for Updating
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can use the sample VNF package below to instantiate VNF to be updated.
In this document, ``TACKER_ROOT`` is the root of tacker's repository on
the server.
.. code-block:: console
$ python3 -m pip install TACKER_ROOT
$ export PYTHONPATH=TACKER_ROOT
$ cd TACKER_ROOT/samples/tests/functional/sol_kubernetes_v2/test_cnf_container_update_before
$ vi pkggen.py
...
@ -108,13 +108,28 @@ You can use the sample VNF package below to instantiate VNF to be updated.
.. note::
In this document, ``TACKER_ROOT`` is the root of tacker's repository on
the server.
This tool requires some Tacker modules, so you need to run it in
an environment where Tacker is installed.
If you have installed Tacker in python virtual environment using devstack,
etc., please activate it as follows before using the tool.
.. code-block:: console
$ source /opt/stack/data/venv/bin/activate
(venv) $ python3 pkggen.py
After you have done the above, you will have the sample VNF package
`test_cnf_container_update_before.zip`.
.. note::
If a file exists with the same name as the zip file being generated,
the tool will fail.
When running the tool again to generate a zip file,
please delete or rename the old zip file.
After creating a VNF package with :command:`openstack vnf package create`,
When the Onboarding State is CREATED, the Operational
State is DISABLED, and the Usage State is NOT_IN_USE, indicate the creation is

4
doc/source/user/v2/getting_started/index.rst
View File

@ -7,7 +7,7 @@ Summary
This lecture enables you to:
- create & delete a sample VNF on the OpenStack with Tacker v2 API
- create & delete a sample VNF on the OpenStack with Tacker v2 API
Following two types of VNF deployment supported by Tacker are introduced in
this lecture.
@ -514,7 +514,7 @@ Instantiate VNF
Required parameter:
- flavourID
- flavourId
Optional parameters:

18
doc/source/user/v2/mgmt_driver_deploy_k8s_with_cilium_cni.rst
View File

@ -23,9 +23,10 @@ with the following configuration.
* simple: Deploy 1 MasterNode and 2 WorkerNodes. This flavor supports Scale
and Heal for WorkerNode.
* complex： Deploy 3 MasterNodes and 2 WorkerNodes. This flavor supports Heal
* complex: Deploy 3 MasterNodes and 2 WorkerNodes. This flavor supports Heal
for MasterNode, Scale and Heal for WorkerNode.
Software version
----------------
@ -143,7 +144,7 @@ Get default security group ID for nfv project
.. code-block:: console
$ auth='--os-username nfv_user --os-project-name nfv --os-password devstack --os-auth-url http://127.0.0.1/identity --os-project-domain-name Default --os-user-domain-name Default'
$ auth='--os-username nfv_user --os-project-name nfv --os-password devstack --os-auth-url http://127.0.0.1/identity --os-project-domain-name Default --os-user-domain-name Default'
$ nfv_project_id=`openstack project list $auth | grep -w '| nfv' | awk '{print $2}'`
$ default_id=`openstack security group list $auth | grep -w 'default' | grep $nfv_project_id | awk '{print $2}'`
@ -247,6 +248,19 @@ The package will be created as sol_v2_kubernetes_vnf_package.zip.
$ python3 pkggen.py
.. note::
This tool requires some Tacker modules, so you need to run it in
an environment where Tacker is installed.
If you have installed Tacker in python virtual environment using devstack,
etc., please activate it as follows before using the tool.
.. code-block:: console
$ source /opt/stack/data/venv/bin/activate
(venv) $ python3 pkggen.py
Register VNF Package
^^^^^^^^^^^^^^^^^^^^

23
doc/source/user/v2/prometheus_plugin.rst
View File

@ -8,6 +8,10 @@ Prometheus Plugin Use Case Guide
using Prometheus 2.45 and Alertmanager 0.26.
See :doc:`/user/architecture` for information about supported versions
of Prometheus and Alertmanager.
Overview
~~~~~~~~
@ -362,25 +366,6 @@ needs to activate sshd.
server config should be accessible by SSH.
Supported versions
------------------
Tacker Zed release
- Prometheus: 2.37
- Alertmanager: 0.24
Tacker Antelope release
- Prometheus: 2.37
- Alertmanager: 0.25
Tacker Bobcat and Caracal release
- Prometheus: 2.45
- Alertmanager: 0.26
Alert rule registration
~~~~~~~~~~~~~~~~~~~~~~~

22
doc/source/user/v2/vnf/deployment_with_user_data/index.rst
View File

@ -123,11 +123,11 @@ by referring to :doc:`/user/vnf-package`.
As an example, you can create a VNF Package as follow.
In this document, ``TACKER_ROOT`` is the root of tacker's repository on
the server.
.. code-block:: console
$ python3 -m pip install TACKER_ROOT
$ export PYTHONPATH=TACKER_ROOT
$ cd TACKER_ROOT/samples/tests/functional/sol_v2_common/basic_lcms_max_individual_vnfc
$ python3 pre.py
+---------------------------+--------------------------------------+
@ -400,13 +400,27 @@ As an example, you can create a VNF Package as follow.
.. note::
In this document, ``TACKER_ROOT`` is the root of tacker's repository on
the server.
This tool requires some Tacker modules, so you need to run it in
an environment where Tacker is installed.
If you have installed Tacker in python virtual environment using devstack,
etc., please activate it as follows before using the tool.
.. code-block:: console
$ source /opt/stack/data/venv/bin/activate
(venv) $ python3 pkggen.py
After you have done the above, you will have the sample VNF package
`basic_lcms_max_individual_vnfc.zip`.
.. note::
If a file exists with the same name as the zip file being generated,
the tool will fail.
When running the tool again to generate a zip file,
please delete or rename the old zip file.
VNF Deployment Procedure as VM
------------------------------

2
doc/source/user/v2/vnf/scale/index.rst
View File

@ -39,7 +39,7 @@ The diagram below shows an overview of the VNF scaling.
.. note::
Scale-in operation deletes VNF from the last registered VM.
Scale-in operation deletes VNF from the last registered VM.
Prerequisites