diff --git a/doc/source/user/etsi_containerized_vnf_usage_guide.rst b/doc/source/user/etsi_containerized_vnf_usage_guide.rst index 6c061cadf..cbdbaf921 100644 --- a/doc/source/user/etsi_containerized_vnf_usage_guide.rst +++ b/doc/source/user/etsi_containerized_vnf_usage_guide.rst @@ -51,6 +51,21 @@ parameters that can be obtained from the Kubernetes Master-node. For specific methods of obtaining "bearer_token" and "ssl_ca_cert", please refer to [#first]_. +By using ``extra`` field, we can register VIM with Helm installed as +the control target of Tacker. + +.. note:: + + * ``extra`` is an optional parameter. + * For VIM using Helm, the following preconditions need to be met: + + * Use the specified user to login through ssh to execute the CLI + command of Helm. + * The specified user has sudo execution permissions for the + mkdir/chown/rm commands and does not require a password. + * Create the /var/tacker/helm directory on VIM as the transfer + destination for Helm chart files. + .. code-block:: console $ cat vim-k8s.yaml @@ -75,6 +90,12 @@ please refer to [#first]_. 2ZrqgOcTmyFzFh9h2dj1DJWvCvExybRmzWK1e8JMzTb40MEApyY= -----END CERTIFICATE-----" type: "kubernetes" + extra: + helm_info: + masternode_ip: + - "192.168.33.100" + masternode_username: "helm_user" + masternode_password: "helm_pass" In addition to using ``bearer_token`` to authenticate with Kubernetes , OpenID token [#sixth]_ is also supported. The following sample specifies @@ -184,6 +205,7 @@ the [1. Create a config file] chapter. | auth_url | https://192.168.33.100:6443 | | created_at | 2020-10-19 08:08:12.116040 | | description | | + | extra | helm_info=masternode_ip=['192.168.33.100'], masternode_password=helm_user, masternode_username=helm_pass | | id | 8d8373fe-6977-49ff-83ac-7756572ed186 | | is_default | False | | name | test-vim-k8s | @@ -218,6 +240,9 @@ Also we can check if the status of VIM is REACHABLE by Prepare VNF Package =================== + +If we want to deploy CNF through helm, we can refer to `Prepare VNF Package`_. + 1. Create Directories of VNF Package ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ TOSCA YAML CSAR file is an archive file using the ZIP file format whose @@ -709,6 +734,9 @@ After the command is executed, the generated ID is ``VNF instance ID``. Instantiate VNF =============== + +If we want to deploy CNF through helm, we can refer to `Instantiate VNF`_. + 1. Set the Value to the Request Parameter File ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Get the ID of target VIM. @@ -919,3 +947,5 @@ References .. [#fifth] https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names .. [#sixth] https://kubernetes.io/docs/reference/access-authn-authz/authentication/#openid-connect-tokens .. [#seventh] https://docs.openstack.org/tacker/latest/reference/kubernetes_openid_token_auth_usage_guide.html +.. _Prepare VNF Package : https://docs.openstack.org/tacker/latest/user/mgmt_driver_deploy_k8s_and_cnf_with_helm.html#prepare-vnf-package +.. _Instantiate VNF : https://docs.openstack.org/tacker/latest/user/mgmt_driver_deploy_k8s_and_cnf_with_helm.html#instantiate-vnf diff --git a/doc/source/user/mgmt_driver_deploy_k8s_and_cnf_with_helm.rst b/doc/source/user/mgmt_driver_deploy_k8s_and_cnf_with_helm.rst index bdbbb60ae..4b957c997 100644 --- a/doc/source/user/mgmt_driver_deploy_k8s_and_cnf_with_helm.rst +++ b/doc/source/user/mgmt_driver_deploy_k8s_and_cnf_with_helm.rst @@ -223,28 +223,22 @@ Deployment`_. Prepare Kubernetes VIM ^^^^^^^^^^^^^^^^^^^^^^ -The following change is required from original section `Prepare Kubernetes -VIM`_: - -* Skip the VIM registration procedure +First, you need to prepare a server with Kubernetes and Helm installed. +If the server is deployed by :ref:`Deploy Kubernetes Cluster by helm`, +you can skip steps 1 and 2 below. 1. Create a Config File ~~~~~~~~~~~~~~~~~~~~~~~ -This step is not required because it is performed in conjunction with the VIM -registration during the Helm installation procedure. -After completing the procedures in this chapter, execute the following -:ref:`Register Kubernetes VIM by helm charts` instead of conventional procedure -(`2. Register Kubernetes VIM`_). - -.. _Register Kubernetes VIM by helm charts: +You can refer to the `Create a Config File`_ section to create a config file. 2. Register Kubernetes VIM ~~~~~~~~~~~~~~~~~~~~~~~~~~ -If Helm is used, no new registration is required because -:ref:`Deploy Kubernetes Cluster by helm` registers VIM when Kubernetes Cluster -is deployed. -For the registered VIM information, confirm that the VIM registered in -:ref:`Deploy Kubernetes Cluster by helm` exists and the Status is "REACHABLE". +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". .. code-block:: console @@ -528,6 +522,8 @@ Reference .. _Instantiate VNF : https://docs.openstack.org/tacker/latest/user/etsi_containerized_vnf_usage_guide.html#set-the-value-to-the-request-parameter-file .. _1. Set the Value to the Request Parameter File : https://docs.openstack.org/tacker/latest/user/etsi_containerized_vnf_usage_guide.html#set-the-value-to-the-request-parameter-file .. _4. Check the Deployment in Kubernetes : https://docs.openstack.org/tacker/latest/user/etsi_containerized_vnf_usage_guide.html#check-the-deployment-in-kubernetes +.. _Create a Config File : https://docs.openstack.org/tacker/latest/user/etsi_containerized_vnf_usage_guide.html#create-a-config-file +.. _Register Kubernetes VIM : https://docs.openstack.org/tacker/latest/user/etsi_containerized_vnf_usage_guide.html#register-kubernetes-vim .. [#Helm-Create] : https://helm.sh/docs/helm/helm_create/ .. [#Helm-Package] : https://helm.sh/docs/helm/helm_package/