From aa2836c0722a68f5503e0138f725eefb8d8829eb Mon Sep 17 00:00:00 2001 From: Ai Hamano Date: Wed, 1 Nov 2023 10:32:37 +0900 Subject: [PATCH] Remove legacy documentation This patch removes documentation for the following legacy commands. - VNF Descriptor (VNFD) Management commands - VNF Management commands - Event Management commands - VNF Forwarding Graph Descriptor (VNFFGD) Management commands - VNF Forwarding Graph (VNFFG) Management commands - Network Forwarding Path Management commands - Service Function Chain (SFC) Management commands - Flow Classifier Management commands - Network Service Descriptor Management commands - Network Service Management commands Implements: blueprint deprecate-legacy-apis Change-Id: I6aa68cd1fa14a838c3058343a7a1603790c9358b --- doc/source/cli/commands.rst | 66 ++++++++----------- doc/source/cli/index.rst | 10 --- doc/source/cli/nfv_event_commands.rst | 24 ------- doc/source/cli/ns_commands.rst | 24 ------- doc/source/cli/ns_descriptor_commands.rst | 24 ------- doc/source/cli/vnf_chain_commands.rst | 24 ------- doc/source/cli/vnf_classifier_commands.rst | 24 ------- doc/source/cli/vnf_commands.rst | 24 ------- doc/source/cli/vnf_descriptor_commands.rst | 24 ------- doc/source/cli/vnf_graph_commands.rst | 24 ------- .../cli/vnf_graph_descriptor_commands.rst | 24 ------- .../vnf_network_forwarding_path_commands.rst | 24 ------- 12 files changed, 26 insertions(+), 290 deletions(-) delete mode 100644 doc/source/cli/nfv_event_commands.rst delete mode 100644 doc/source/cli/ns_commands.rst delete mode 100644 doc/source/cli/ns_descriptor_commands.rst delete mode 100644 doc/source/cli/vnf_chain_commands.rst delete mode 100644 doc/source/cli/vnf_classifier_commands.rst delete mode 100644 doc/source/cli/vnf_commands.rst delete mode 100644 doc/source/cli/vnf_descriptor_commands.rst delete mode 100644 doc/source/cli/vnf_graph_commands.rst delete mode 100644 doc/source/cli/vnf_graph_descriptor_commands.rst delete mode 100644 doc/source/cli/vnf_network_forwarding_path_commands.rst diff --git a/doc/source/cli/commands.rst b/doc/source/cli/commands.rst index e3c41f5e..c39cadb8 100644 --- a/doc/source/cli/commands.rst +++ b/doc/source/cli/commands.rst @@ -23,50 +23,14 @@ of individual command can be referred by **openstack help **. .. code-block:: console - openstack vnf create Create a VNF. - openstack vnf delete Delete given VNF(s). - openstack vnf list List VNF(s) that belong to a given tenant. - openstack vnf resource list List resources of a VNF like VDU, CP, etc. - openstack vnf scale Scale a VNF. - openstack vnf show Show information of a given VNF. - openstack vnf set Update a given VNF. - openstack vnf descriptor create Create a VNFD. - openstack vnf descriptor delete Delete given VNFD(s). - openstack vnf descriptor list List VNFD(s) that belong to a given tenant. - openstack vnf descriptor show Show information of a given VNFD. - openstack vnf descriptor template show Show template of a given VNFD. + [legacy] openstack vim list List VIM(s) that belong to a given tenant. openstack vim register Create a VIM. openstack vim show Show information of a given VIM. openstack vim set Update a given VIM. openstack vim delete Delete given VIM(s). - openstack ns create Create a NS. - openstack ns delete Delete given NS(s). - openstack ns list List NS that belong to a given tenant. - openstack ns show Show information of a given NS. - openstack ns descriptor create Create a NSD. - openstack ns descriptor delete Delete a given NSD. - openstack ns descriptor list List NSD(s) that belong to a given tenant. - openstack ns descriptor show Show information of a given NSD. - openstack ns descriptor template show Show template of a given NSD. - openstack vnf graph create Create a VNFFG. - openstack vnf graph delete Delete a given VNFFG. - openstack vnf graph list List VNFFG(s) that belong to a given tenant. - openstack vnf graph show Show information of a given VNFFG. - openstack vnf graph set Update a given VNFFG. - openstack vnf graph descriptor create Create a VNFFGD. - openstack vnf graph descriptor delete Delete a given VNFFGD. - openstack vnf graph descriptor list List VNFFGD(s) that belong to a given tenant. - openstack vnf graph descriptor show Show information of a given VNFFGD. - openstack vnf graph descriptor template show Show template of a given VNFFGD. - openstack vnf chain list List SFC(s) that belong to a given tenant. - openstack vnf chain show Show information of a given SFC. - openstack vnf classifier list List FC(s) that belong to a given tenant. - openstack vnf classifier show Show information of a given FC. - openstack vnf network forwarding path list List NFP(s) that belong to a given tenant. - openstack vnf network forwarding path show Show information of a given NFP. - openstack nfv event show Show event given the event id. - openstack nfv event list List events of resources. + + [v1] --os-tacker-api-version 1 openstack vnf package create Create a new individual VNF package resource. openstack vnf package delete Delete given VNF package(s). openstack vnf package list List all VNF packages. @@ -85,7 +49,6 @@ of individual command can be referred by **openstack help **. openstack vnflcm update Update information of a VNF instance. openstack vnflcm scale Scale a VNF instance. openstack vnflcm change-ext-conn Change external VNF connectivity. - openstack vnflcm change-vnfpkg Change current VNF package. openstack vnflcm op rollback Rollback a VNF LCM operation occurrence. openstack vnflcm op retry Retry a VNF LCM operation occurrence. openstack vnflcm op fail Fail a VNF LCM operation occurrence. @@ -97,6 +60,29 @@ of individual command can be referred by **openstack help **. openstack vnflcm subsc delete Delete subscription. openstack vnflcm subsc list List subscription. openstack vnflcm subsc show Show subscription. + + [v2] --os-tacker-api-version 2 + openstack vnflcm create Create a new VNF instance resource. + openstack vnflcm instantiate Instantiate a VNF instance. + openstack vnflcm list List VNF instance. + openstack vnflcm show Show VNF instance. + openstack vnflcm terminate Terminate a VNF instance. + openstack vnflcm delete Delete a VNF instance resource. + openstack vnflcm heal Heal a VNF instance. + openstack vnflcm update Update information of a VNF instance. + openstack vnflcm scale Scale a VNF instance. + openstack vnflcm change-ext-conn Change external VNF connectivity. + openstack vnflcm change-vnfpkg Change current VNF package. + openstack vnflcm op rollback Rollback a VNF LCM operation occurrence. + openstack vnflcm op retry Retry a VNF LCM operation occurrence. + openstack vnflcm op fail Fail a VNF LCM operation occurrence. + openstack vnflcm op list List VNF LCM operation occurrence. + openstack vnflcm op show Show VNF LCM operation occurrence. + openstack vnflcm versions Show VNF LCM API versions. + openstack vnflcm subsc create Create new subscription. + openstack vnflcm subsc delete Delete subscription. + openstack vnflcm subsc list List subscription. + openstack vnflcm subsc show Show subscription. openstack vnffm alarm list List alarm. openstack vnffm alarm show Show alarm. openstack vnffm alarm update Update alarm. diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst index 1ebe6f6c..d7ef81c4 100644 --- a/doc/source/cli/index.rst +++ b/doc/source/cli/index.rst @@ -37,14 +37,4 @@ Operations for Legacy implementation .. toctree:: - vnf_commands - vnf_descriptor_commands vim_commands - ns_commands - ns_descriptor_commands - vnf_graph_commands - vnf_graph_descriptor_commands - vnf_chain_commands - vnf_classifier_commands - vnf_network_forwarding_path_commands - nfv_event_commands diff --git a/doc/source/cli/nfv_event_commands.rst b/doc/source/cli/nfv_event_commands.rst deleted file mode 100644 index 55cb5586..00000000 --- a/doc/source/cli/nfv_event_commands.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. - Licensed under the Apache License, Version 2.0 (the "License"); you may - not use this file except in compliance with the License. You may obtain - a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - License for the specific language governing permissions and limitations - under the License. - -========================= -Event Management commands -========================= - -.. warning:: - Event Management commands are deprecated - and will be removed in the first major release after the Tacker server - version 9.0.0 (2023.1 Antelope release). - -.. autoprogram-cliff:: openstack.tackerclient.v1 - :command: nfv event * diff --git a/doc/source/cli/ns_commands.rst b/doc/source/cli/ns_commands.rst deleted file mode 100644 index b46192c3..00000000 --- a/doc/source/cli/ns_commands.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. - Licensed under the Apache License, Version 2.0 (the "License"); you may - not use this file except in compliance with the License. You may obtain - a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - License for the specific language governing permissions and limitations - under the License. - -=================================== -Network Service Management commands -=================================== - -.. warning:: - Network Service Management commands are deprecated - and will be removed in the first major release after the Tacker server - version 9.0.0 (2023.1 Antelope release). - -.. autoprogram-cliff:: openstack.tackerclient.v1 - :command: ns * diff --git a/doc/source/cli/ns_descriptor_commands.rst b/doc/source/cli/ns_descriptor_commands.rst deleted file mode 100644 index 182dafef..00000000 --- a/doc/source/cli/ns_descriptor_commands.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. - Licensed under the Apache License, Version 2.0 (the "License"); you may - not use this file except in compliance with the License. You may obtain - a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - License for the specific language governing permissions and limitations - under the License. - -============================================== -Network Service Descriptor Management commands -============================================== - -.. warning:: - Network Service Descriptor Management commands are deprecated - and will be removed in the first major release after the Tacker server - version 9.0.0 (2023.1 Antelope release). - -.. autoprogram-cliff:: openstack.tackerclient.v1 - :command: ns descriptor * diff --git a/doc/source/cli/vnf_chain_commands.rst b/doc/source/cli/vnf_chain_commands.rst deleted file mode 100644 index 3822c6ee..00000000 --- a/doc/source/cli/vnf_chain_commands.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. - Licensed under the Apache License, Version 2.0 (the "License"); you may - not use this file except in compliance with the License. You may obtain - a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - License for the specific language governing permissions and limitations - under the License. - -================================================ -Service Function Chain (SFC) Management commands -================================================ - -.. warning:: - Service Function Chain (SFC) Management commands are deprecated - and will be removed in the first major release after the Tacker server - version 9.0.0 (2023.1 Antelope release). - -.. autoprogram-cliff:: openstack.tackerclient.v1 - :command: vnf chain * diff --git a/doc/source/cli/vnf_classifier_commands.rst b/doc/source/cli/vnf_classifier_commands.rst deleted file mode 100644 index 95196a60..00000000 --- a/doc/source/cli/vnf_classifier_commands.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. - Licensed under the Apache License, Version 2.0 (the "License"); you may - not use this file except in compliance with the License. You may obtain - a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - License for the specific language governing permissions and limitations - under the License. - -=================================== -Flow Classifier Management commands -=================================== - -.. warning:: - Flow Classifier Management commands are deprecated - and will be removed in the first major release after the Tacker server - version 9.0.0 (2023.1 Antelope release). - -.. autoprogram-cliff:: openstack.tackerclient.v1 - :command: vnf classifier * diff --git a/doc/source/cli/vnf_commands.rst b/doc/source/cli/vnf_commands.rst deleted file mode 100644 index e92ea84b..00000000 --- a/doc/source/cli/vnf_commands.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. - Licensed under the Apache License, Version 2.0 (the "License"); you may - not use this file except in compliance with the License. You may obtain - a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - License for the specific language governing permissions and limitations - under the License. - -======================= -VNF Management commands -======================= - -.. warning:: - VNF Management commands are deprecated - and will be removed in the first major release after the Tacker server - version 9.0.0 (2023.1 Antelope release). - -.. autoprogram-cliff:: openstack.tackerclient.v1 - :command: vnf * diff --git a/doc/source/cli/vnf_descriptor_commands.rst b/doc/source/cli/vnf_descriptor_commands.rst deleted file mode 100644 index f95f2f9f..00000000 --- a/doc/source/cli/vnf_descriptor_commands.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. - Licensed under the Apache License, Version 2.0 (the "License"); you may - not use this file except in compliance with the License. You may obtain - a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - License for the specific language governing permissions and limitations - under the License. - -========================================= -VNF Descriptor (VNFD) Management commands -========================================= - -.. warning:: - VNF Descriptor (VNFD) Management commands are deprecated - and will be removed in the first major release after the Tacker server - version 9.0.0 (2023.1 Antelope release). - -.. autoprogram-cliff:: openstack.tackerclient.v1 - :command: vnf descriptor * diff --git a/doc/source/cli/vnf_graph_commands.rst b/doc/source/cli/vnf_graph_commands.rst deleted file mode 100644 index ea0981f2..00000000 --- a/doc/source/cli/vnf_graph_commands.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. - Licensed under the Apache License, Version 2.0 (the "License"); you may - not use this file except in compliance with the License. You may obtain - a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - License for the specific language governing permissions and limitations - under the License. - -================================================ -VNF Forwarding Graph (VNFFG) Management commands -================================================ - -.. warning:: - VNF Forwarding Graph (VNFFG) Management commands are deprecated - and will be removed in the first major release after the Tacker server - version 9.0.0 (2023.1 Antelope release). - -.. autoprogram-cliff:: openstack.tackerclient.v1 - :command: vnf graph * diff --git a/doc/source/cli/vnf_graph_descriptor_commands.rst b/doc/source/cli/vnf_graph_descriptor_commands.rst deleted file mode 100644 index 8d3d5f03..00000000 --- a/doc/source/cli/vnf_graph_descriptor_commands.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. - Licensed under the Apache License, Version 2.0 (the "License"); you may - not use this file except in compliance with the License. You may obtain - a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - License for the specific language governing permissions and limitations - under the License. - -============================================================ -VNF Forwarding Graph Descriptor (VNFFGD) Management commands -============================================================ - -.. warning:: - VNF Forwarding Graph Descriptor (VNFFGD) Management commands are deprecated - and will be removed in the first major release after the Tacker server - version 9.0.0 (2023.1 Antelope release). - -.. autoprogram-cliff:: openstack.tackerclient.v1 - :command: vnf graph descriptor * diff --git a/doc/source/cli/vnf_network_forwarding_path_commands.rst b/doc/source/cli/vnf_network_forwarding_path_commands.rst deleted file mode 100644 index f4090739..00000000 --- a/doc/source/cli/vnf_network_forwarding_path_commands.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. - Licensed under the Apache License, Version 2.0 (the "License"); you may - not use this file except in compliance with the License. You may obtain - a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - License for the specific language governing permissions and limitations - under the License. - -=========================================== -Network Forwarding Path Management commands -=========================================== - -.. warning:: - Network Forwarding Path Management commands are deprecated - and will be removed in the first major release after the Tacker server - version 9.0.0 (2023.1 Antelope release). - -.. autoprogram-cliff:: openstack.tackerclient.v1 - :command: vnf network forwarding path *