Remove tpmconfig Sysinv APIs

With the new Certificate orchestration APIs added for Distributed Cloud,
there is no need to have separate tpmconfig-XXX APIs. In the interest of
minimizing code bloat, this commit gets rid of the SysInv APIs for
tpmconfig, the CGCTS CLI equivalents, and the REST API documentation.
Notice that as a CLI only convenience we support passing in the reserved
"tpm" keyword in place of the UUID in order to save users from first
listing to query UUID and then doing a show

Change-Id: I5a13668b20e7988319b08f0df1a00e839633d01d
Signed-off-by: Kristine Bujold <kristine.bujold@windriver.com>
This commit is contained in:
Kam Nasim 2018-03-21 15:09:22 -04:00 committed by Kristine Bujold
parent 1d9e289e39
commit 2e5319c05b
9 changed files with 11 additions and 264 deletions

View File

@ -1368,35 +1368,6 @@ configuration entity for the system.
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- TPM CONFIGURATION -->
<!--*******************************************************-->
<section xml:id="tpmconfig-v1">
<title>Trusted Platform Module (TPM) Configuration</title>
<para>These APIs allow for the display and configuration of
Trusted Platform Module (TPM).
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#tpmconfig">
<wadl:method href="#showTpmConfig"/>
</wadl:resource>
<wadl:resource
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#tpmconfig">
<wadl:method href="#addTpmConfig"/>
</wadl:resource>
<wadl:resource
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#tpmconfig_id">
<wadl:method href="#modifyTpmConfig"/>
</wadl:resource>
<wadl:resource
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#tpmconfig_id">
<wadl:method href="#deleteTpmConfig"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- CUSTOM FIREWALL RULES -->
<!--*******************************************************-->

View File

@ -1,8 +1,14 @@
{
"uuid": "ada8f12c-0ab2-49b7-bad9-946e34cedd69",
"certtype": "ssl",
"certtype": "tpm_mode",
"expiry_date": "2018-03-27T18:15:23+00:00",
"signature": "ssl_14615813356245445293",
"start_date": "2017-03-27T18:15:23+00:00",
"issuer": null
"issuer": null,
"details": {
"state" : {
"controller-0": "tpm-config-applied",
"controller-1": "tpm-config-applied"
}
}
}

View File

@ -1,5 +0,0 @@
{
"cert_path" : "/etc/ssl/private/key.pem",
"public_path" : "/etc/ssl/private/cert.pem",
"tpm_path" : "/etc/ssl/private/object.tpm"
}

View File

@ -1,19 +0,0 @@
{
"tpm_path": "/etc/ssl/private/object.tpm",
"uuid": "6e06345a-9d02-41bf-9af7-4593ad7db14c",
"links": [{
"href": "http://192.168.204.2:6385/v1/tpmconfigs/6e06345a-9d02-41bf-9af7-4593ad7db14c",
"rel": "self"
}, {
"href": "http://192.168.204.2:6385/tpmconfigs/6e06345a-9d02-41bf-9af7-4593ad7db14c",
"rel": "bookmark"
}],
"public_path": null,
"created_at": "2017-05-30T16:52:36.788395+00:00",
"updated_at": null,
"state": {
"controller-0": "tpm-config-applying",
"controller-1": "tpm-config-applying"
},
"cert_path": null
}

View File

@ -1,14 +0,0 @@
[{
"path" : "/cert_path",
"value" : "/etc/ssl/private/key2.pem",
"op" : "replace"
}, {
"path" : "/public_path",
"value" : "/etc/ssl/private/cert2.pem",
"op" : "replace"
}, {
"path" : "/tpm_path",
"value" : "/etc/ssl/private/object2.tpm",
"op" : "replace"
}
]

View File

@ -1,19 +0,0 @@
{
"tpm_path": "/etc/ssl/private/object2.tpm",
"uuid": "6e06345a-9d02-41bf-9af7-4593ad7db14c",
"links": [{
"href": "http://192.168.204.2:6385/v1/tpmconfigs/6e06345a-9d02-41bf-9af7-4593ad7db14c",
"rel": "self"
}, {
"href": "http://192.168.204.2:6385/tpmconfigs/6e06345a-9d02-41bf-9af7-4593ad7db14c",
"rel": "bookmark"
}],
"public_path": null,
"created_at": "2017-05-30T16:52:36.788395+00:00",
"updated_at": "2017-06-21T15:12:16.666333+00:00",
"state": {
"controller-0": "tpm-config-applying",
"controller-1": "tpm-config-applying"
},
"cert_path": null
}

View File

@ -1,20 +0,0 @@
{
"tpmconfigs": [{
"tpm_path": "/etc/ssl/private/object.tpm",
"uuid": "556159b8-f39b-47ec-a410-e2d5499b6661",
"links": [{
"href": "http://192.168.204.2:6385/v1/tpmconfigs/556159b8-f39b-47ec-a410-e2d5499b6661",
"rel": "self"
}, {
"href": "http://192.168.204.2:6385/tpmconfigs/556159b8-f39b-47ec-a410-e2d5499b6661",
"rel": "bookmark"
}],
"public_path": null,
"created_at": "2017-05-30T14:49:16.445438+00:00",
"updated_at": null,
"state": {
"controller-0": "tpm-config-applied"
},
"cert_path": null
}]
}

View File

@ -4161,37 +4161,6 @@
</param>
'>
<!-- TPM configuration Common Parameters -->
<!ENTITY tpmconfigCommonParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="cert_path" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This parameter specifies the path to the certificate (private)
to upload to TPM.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="tpm_path" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This parameter specifies the path to store the TPM
object context.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="public_path" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This parameter specifies the path to store the public certificate
</para>
</wadl:doc>
</param>
'>
<!-- License List Parameters -->
<!ENTITY licenseListParameters '

View File

@ -1022,24 +1022,6 @@ SPDX-License-Identifier: Apache-2.0
<method href="#showCert"/>
</resource>
<!-- /v1/tpmconfig -->
<resource id="tpmconfig" path="tpmconfig">
<method href="#showTpmConfig"/>
<method href="#addTpmConfig"/>
</resource>
<!-- /v1/tpmconfig/{tpmconfig_id} -->
<resource id="tpmconfig_id" path="{tpmconfig_id}" >
<param name="tpmconfig_id" style="template" required="true"
type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of the TPM configuration.</para>
</wadl:doc>
</param>
<method href="#deleteTpmConfig"/>
<method href="#modifyTpmConfig"/>
</resource>
<!-- /v1/firewallrules/import_firewall_rules -->
<resource id="firewallrules" path="firewallrules/import_firewall_rules">
<method href="#importFirewallRules"/>
@ -7344,7 +7326,9 @@ OAM Controller-1 IP Address.</para>
<method name="GET" id="showCert">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show Certificate configuration">
<para role="shortdesc">Shows attributes of the Certificate configuration.</para>
<para role="shortdesc">Shows attributes of the Certificate configuration, including
additional details if available for that certificate mode
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
@ -7380,112 +7364,6 @@ OAM Controller-1 IP Address.</para>
&commonFaults; &getFaults;
</method>
<!-- ..................................................... -->
<!-- .. TPM Configuration .. -->
<!-- ..................................................... -->
<method name="GET" id="showTpmConfig">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show TPM configuration">
<para role="shortdesc">Shows attributes of the TPM configuration.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/tpmconfig_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="POST" id="addTpmConfig">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create a TPM configuration">
<para role="shortdesc">Adds a TPM configuration.</para>
<para></para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&tpmconfigCommonParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/tpmconfig_add-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&tpmconfigCommonParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/tpmconfig_add-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="PATCH" id="modifyTpmConfig">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify a TPM configuration">
<para role="shortdesc">Modifies a TPM configuration.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&tpmconfigCommonParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/tpmconfig_modify-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&tpmconfigCommonParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/tpmconfig_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="DELETE" id="deleteTpmConfig">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete a TPM configuration">
<para role="shortdesc">Deletes a TPM configuration.</para>
<para></para>
</wadl:doc>
<response status="204">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
</representation>
</response>
</method>
<!-- ..................................................... -->
<!-- .. Custom Firewall Rules .. -->
<!-- ..................................................... -->