openstack/tacker-specs
Code Issues Proposed changes
5e61915ba1
tacker-specs/specs/2023.1/support-multi-conductors-onboarding.rst
Yasufumi Ogawa af542c4418 Remove sphinxcontrib-*diag 
As suggested open openstack-discuss ML[1], some sphinxcontrib packages
have not been updated for several years and might going to be
maintained anymore. In tacker-specs repo, many diagrams are compiled
with sphinxcontrib-seqdiag and sphinxcontrib-nwdiag. This update is to
drop using the packages and add image files instead. The embedded
source codes are remained as separated files and named as "*.diag".

In addition, it includes two updates other than that.

* usage of the dropped diagram support described in the
  `specs/template.rst` is also removed because it's no longer
  supported.

* Upgrade the version of `pillow` to the latest 11.0.0 since
  installation is failed if the version is old.

[1] https://lists.openstack.org/archives/list/openstack-discuss@lists.openstack.org/message/4IID4UEXY4PJJGBTMFMTRYLKJIN4GOQ6/

Change-Id: I8cede6de0770b68a9984617643aa4aa81e47ba5c
2024-12-04 09:01:41 +00:00

7.8 KiB
Raw Blame History

Support Onboarding In Multiple Conductors Environment

https://blueprints.launchpad.net/tacker/+spec/support-multi-conductors-onboarding

In current implementation, onboarding process doesn't work when using Tacker as N-Act cluster.

This specification describes enhancement of managing VNF packages by multiple Tacker conductors.

Problem description

In current implementation, onboarding process are as follows.

  • when receiving the "PUT /vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content" request.
    1. Tacker-server receives "PUT /vnfpkgm/v1/vnf_packages/{vnf_package_id}/package_content" request.
    2. Tacker-server updates the onboardingState on DB to "UPLOADING".
    3. Tacker-server uploads a CSAR file to a backend storage.
    4. Tacker-server sends a rpc message of Upload VNF Package from content with fanout=False
    5. The Tacker-conductor that gets the message first downloads the CSAR file to its local file system.
    6. Tacker-server updates the onboardingState on DB to "ONBOARDED".

The sequence of the process is as follows.

image

  • when receiving the "POST /vnfpkgm/v1/vnf_packages/{vnf_package_id} /package_content/upload_from_uri" request.
    1. Tacker-server receives "POST /vnfpkgm/v1/vnf_packages/ {vnf_package_id}/package_content/upload_from_uri" request.
    2. Tacker-server updates the onboardingState on DB to "UPLOADING".
    3. Tacker-server sends a rpc message of Upload VNF Package from uri with fanout=False.
    4. The Tacker-conductor that gets the message first uploads a CSAR file to a backend storage.
    5. The same Tacker-conductor downloads the CSAR file to its local file system.
    6. The same Tacker-conductor updates the onboardingState on DB to "ONBOARDED".

The sequence of the process is as follows.

image

Note

Configurations of a backend storage are defined in [glance_store] section in tacker.conf. For example, the type of a backend storage is configured by stores in [glance_store]. Configurations of a local file system for VNF packages are defined in [vnf_package] section in tacker.conf. For example, the path where vnf packages are downloaded is configured by vnf_package_csar_path in [vnf_package].

If conductors are running on multiple nodes, the only conductor that will receive the onboarding request first can download a CSAR file to its local file system following the process above. But other conductors that don't receive the request can't download a CSAR file at the time, and so these conductors can't operate instantiation because they can't refer to the CSAR file.

Consider a user who wants to use external storage such as Object Storage to store VNF packages and make it shareable by multiple conductors, it is necessary to enable all conductors to download CSAR files.

Proposed change

We would enable all conductors in the N-Act cluster to download a CSAR file at the onboarding process.

The process of onboarding VNF package

We would change the process of onboarding as follows.

  • when receiving the "PUT /vnfpkgm/v1/vnf_packages/{vnf_package_id}/ package_content" request.
    1. Tacker-server receives "PUT /vnfpkgm/v1/vnf_packages/{vnf_package_id}/package_content" request.
    2. Tacker-server updates the onboardingState to "UPLOADING".
    3. Tacker-server uploads a CSAR file to a backend storage.
    4. Tacker-server sends a rpc message of Upload VNF Package from content with fanout=False to Tacker-conductor.
    5. The Tacker-conductor that gets the message first sends a rpc message to download the CSAR file with fanout=True to all Tacker-conductors including itself.
    6. All Tacker-conductors that get the message download the CSAR file to their local file system and return a result via rpc.
    7. The Tacker-conductor that sends a message to all Tacker-conductors updates the onboardingState to "ONBOARDED".

image

  • when receiving the "POST /vnfpkgm/v1/vnf_packages/{vnf_package_id}/ package_content/upload_from_uri" request.
    1. Tacker-server receives "POST /vnfpkgm/v1/vnf_packages/{vnf_package_id} /package_content/upload_from_uri" request.
    2. Tacker-server update the onboardingState to "UPLOADING".
    3. Tacker-server send a rpc message of Upload VNF Package from uri with fanout=False
    4. The Tacker-conductor that gets the message first uploads a CSAR file to a backend storage.
    5. The same Tacker-conductor sends a rpc message to download the CSAR file with fanout=True to all Tacker-conductors including itself.
    6. All Tacker-conductors that get the message download the CSAR file to their local file system and return a result via rpc.
    7. The Tacker-conductor that sends a message to all Tacker-conductors updates the onboardingState to "ONBOARDED".

image

Note

If even one of the Tacker-conductor fails to download CSAR file, the onboardingState is not being updated to "ONBOARDED".

The process of deleting VNF packages

We would change the process of deleting VNF packages as follows.

  • when receiving "DELETE /vnfpkgm/v1/vnf_packages/{vnf_package_id}" request.
    1. Tacker-server receives "DELETE /vnfpkgm/v1/vnf_packages/{vnf_package_id}" request.
    2. Tacker-server update the delete flag of the related record to 1.
    3. Tacker-server send a rpc message of "Delete VNF Package" with fanout=False.
    4. The Tacker-conductor that gets the message first delete the file from backend storage.
    5. The same Tacker-conductor send a rpc message to delete the file from local file system with fanout=True to all Tacker-conductors including itself.
    6. All Tacker-conductors that get the message delete the file from their local file system and return a result via rpc.

image

If a Tacker-conductor is newly added to the cluster, the following process should be executed to download onboarded VNF package to its local file system.

  1. The Tacker-conductor get the list of VNF packages whose state is ONBOARDED.
  2. The Tacker-conductor downloads the VNF packages to its local file systems.

Note

Tacker-conductor must not receive any requests until the above process is completed.

Data model impact

The downloading field is added to VnfPackage table. This field counts the number of conductors downloading VNF packages to determine whether all conductors could download or not.

  • Table: VnfPackage
    Name Type
    downloading int

REST API impact

None

Security impact

None

Notifications impact

None

Other end user impact

None

Performance Impact

None

Other deployer impact

None

Developer impact

None

Implementation

Assignee(s)

Primary assignee:

Masaki Oyama <ma-ooyama@kddi.com>

Other contributors:

Hitomi Koba <hi-koba@kddi.com>

Yukihiro Kinjo <yu-kinjou@kddi.com>

Xu Hongjin <ho-xu@kddi.com>

Work Items

  • Implement onboarding function
  • Add unit test
  • Add functional test

Dependencies

None

Testing

Unit test and functional test will be added.

Documentation Impact

None

References

None