diff --git a/api-ref/source/apis/cluster_management/accepting_a_node.rst b/api-ref/source/apis/cluster_management/accepting_a_node.rst index ba60b44..ca5771d 100644 --- a/api-ref/source/apis/cluster_management/accepting_a_node.rst +++ b/api-ref/source/apis/cluster_management/accepting_a_node.rst @@ -111,11 +111,17 @@ Request Parameters .. table:: **Table 6** Login - ========= ========= ====== ==================================== - Parameter Mandatory Type Description - ========= ========= ====== ==================================== - sshKey No String Name of the key pair used for login. - ========= ========= ====== ==================================== + +-----------------+-----------------+-----------------+---------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=========================================================+ + | sshKey | No | String | Name of the key pair used for login. | + +-----------------+-----------------+-----------------+---------------------------------------------------------+ + | userPassword | No | String | Password used for node login. | + | | | | | + | | | | .. note:: | + | | | | | + | | | | This field is not supported for the current version. | + +-----------------+-----------------+-----------------+---------------------------------------------------------+ .. _addnode__en-us_topic_0000001417516392_request_reinstallserverconfig: diff --git a/api-ref/source/apis/cluster_management/migrating_a_node.rst b/api-ref/source/apis/cluster_management/migrating_a_node.rst index b54b9c3..8d11282 100644 --- a/api-ref/source/apis/cluster_management/migrating_a_node.rst +++ b/api-ref/source/apis/cluster_management/migrating_a_node.rst @@ -121,11 +121,17 @@ Request Parameters .. table:: **Table 6** Login - ========= ========= ====== ==================================== - Parameter Mandatory Type Description - ========= ========= ====== ==================================== - sshKey No String Name of the key pair used for login. - ========= ========= ====== ==================================== + +-----------------+-----------------+-----------------+---------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=========================================================+ + | sshKey | No | String | Name of the key pair used for login. | + +-----------------+-----------------+-----------------+---------------------------------------------------------+ + | userPassword | No | String | Password used for node login. | + | | | | | + | | | | .. note:: | + | | | | | + | | | | This field is not supported for the current version. | + +-----------------+-----------------+-----------------+---------------------------------------------------------+ .. _migratenode__en-us_topic_0000001467833433_request_nodeitem: @@ -229,11 +235,17 @@ Response Parameters .. table:: **Table 12** Login - ========= ====== ==================================== - Parameter Type Description - ========= ====== ==================================== - sshKey String Name of the key pair used for login. - ========= ====== ==================================== + +-----------------------+-----------------------+---------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=========================================================+ + | sshKey | String | Name of the key pair used for login. | + +-----------------------+-----------------------+---------------------------------------------------------+ + | userPassword | String | Password used for node login. | + | | | | + | | | .. note:: | + | | | | + | | | This field is not supported for the current version. | + +-----------------------+-----------------------+---------------------------------------------------------+ .. _migratenode__en-us_topic_0000001467833433_response_nodeitem: diff --git a/api-ref/source/apis/cluster_management/removing_a_node.rst b/api-ref/source/apis/cluster_management/removing_a_node.rst index be19ec0..f5b52a5 100644 --- a/api-ref/source/apis/cluster_management/removing_a_node.rst +++ b/api-ref/source/apis/cluster_management/removing_a_node.rst @@ -72,11 +72,17 @@ Request Parameters .. table:: **Table 5** Login - ========= ========= ====== ==================================== - Parameter Mandatory Type Description - ========= ========= ====== ==================================== - sshKey No String Name of the key pair used for login. - ========= ========= ====== ==================================== + +-----------------+-----------------+-----------------+---------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=========================================================+ + | sshKey | No | String | Name of the key pair used for login. | + +-----------------+-----------------+-----------------+---------------------------------------------------------+ + | userPassword | No | String | Password used for node login. | + | | | | | + | | | | .. note:: | + | | | | | + | | | | This field is not supported for the current version. | + +-----------------+-----------------+-----------------+---------------------------------------------------------+ .. _removenode__en-us_topic_0000001417833320_request_nodeitem: @@ -133,11 +139,17 @@ Response Parameters .. table:: **Table 10** Login - ========= ====== ==================================== - Parameter Type Description - ========= ====== ==================================== - sshKey String Name of the key pair used for login. - ========= ====== ==================================== + +-----------------------+-----------------------+---------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=========================================================+ + | sshKey | String | Name of the key pair used for login. | + +-----------------------+-----------------------+---------------------------------------------------------+ + | userPassword | String | Password used for node login. | + | | | | + | | | .. note:: | + | | | | + | | | This field is not supported for the current version. | + +-----------------------+-----------------------+---------------------------------------------------------+ .. _removenode__en-us_topic_0000001417833320_response_nodeitem: diff --git a/api-ref/source/apis/cluster_management/resetting_a_node.rst b/api-ref/source/apis/cluster_management/resetting_a_node.rst index e19f7a5..8a2426b 100644 --- a/api-ref/source/apis/cluster_management/resetting_a_node.rst +++ b/api-ref/source/apis/cluster_management/resetting_a_node.rst @@ -111,11 +111,17 @@ Request Parameters .. table:: **Table 6** Login - ========= ========= ====== ==================================== - Parameter Mandatory Type Description - ========= ========= ====== ==================================== - sshKey No String Name of the key pair used for login. - ========= ========= ====== ==================================== + +-----------------+-----------------+-----------------+---------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=========================================================+ + | sshKey | No | String | Name of the key pair used for login. | + +-----------------+-----------------+-----------------+---------------------------------------------------------+ + | userPassword | No | String | Password used for node login. | + | | | | | + | | | | .. note:: | + | | | | | + | | | | This field is not supported for the current version. | + +-----------------+-----------------+-----------------+---------------------------------------------------------+ .. _resetnode__en-us_topic_0000001467713153_request_reinstallserverconfig: diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index 044bbcc..ebf4cee 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -24,7 +24,7 @@ extensions = [ otcdocs_auto_name = False otcdocs_auto_version = False -project = 'Cloud Container Service' +project = 'Cloud Container Engine' otcdocs_repo_name = 'docs/cloud-container-engine' # Those variables are required for edit/bug links otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com' @@ -86,7 +86,7 @@ html_theme_options = { # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -html_title = "Cloud Container Service - API Reference" +html_title = "Cloud Container Engine - API Reference" # Add any paths that contain custom static files (such as style sheets) here, @@ -101,6 +101,6 @@ html_copy_source = False latex_documents = [ ('index', 'cce-api-ref.tex', - u'Cloud Container Service - API Reference', + u'Cloud Container Engine - API Reference', u'OpenTelekomCloud', 'manual'), ] diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index acfd3c5..b022e15 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -1,6 +1,6 @@ -======================================= -Cloud Container Service - API Reference -======================================= +====================================== +Cloud Container Engine - API Reference +====================================== .. toctree:: :maxdepth: 1