ibm-cloud-docs / hs-crypto

hs-crypto
3 stars 22 forks source link

Instruction Incorrect for Initializing Hyper Protect Crypto Services with IBM Cloud TKE CLI #48

Closed daniel-butler-irl closed 1 year ago

daniel-butler-irl commented 1 year ago

From the UI Link to getting started image

https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started#initialize-crypto The link to Video: Initializing Hyper Protect Crypto Services with IBM Cloud TKE CLI https://mediacenter.ibm.com/media/0_z5c589ou Has what seems to be an outdated command. It says to exit imprint mode with ibmcloud tke cryptounit-exit-impr This not a valid command in the latest plugin version.

> ibmcloud plugin show tke

Plugin Name                              tke
Plugin Version                           1.3.1
Plugin SDK Version                       0.11.0
Minimal IBM Cloud CLI version required   N/A
Private endpoints supported              true

Commands:
 tke                           Manage crypto units in the IBM Cloud
 tke mks                       Lists EP11 master key parts stored on this workstation.
 tke mk-add                    Creates and saves a new EP11 master key part.
 tke mk-rm                     Removes an EP11 master key part from this workstation.
 tke sigkeys                   Lists the signature keys stored on this workstation.
 tke sigkey-add                Generates and saves a new signature key.
 tke sigkey-rm                 Removes a signature key from this workstation.
 tke sigkey-sel                Selects the signature keys to use to sign commands.
 tke cryptounits               Displays the crypto units for the current resource group.
 tke cryptounit-add            Adds crypto units to the set of crypto units to work with.
 tke cryptounit-rm             Removes crypto units from the set of crypto units to work with.
 tke cryptounit-admins         Lists administrators installed in the selected crypto units.
 tke cryptounit-admin-add      Adds a crypto unit administrator to the selected crypto units.
 tke cryptounit-admin-rm       Removes a crypto unit administrator from the selected crypto units.
 tke cryptounit-compare        Compares configuration settings of the selected crypto units.
 tke cryptounit-thrhlds        Displays signature thresholds for the selected crypto units.
 tke cryptounit-thrhld-set     Sets the signature thresholds for the selected crypto units.
 tke cryptounit-zeroize        Zeroizes the selected crypto units.
 tke cryptounit-mks            Displays master key registers for the selected crypto units.
 tke cryptounit-mk-clrcur      Clears the current master key register.
 tke cryptounit-mk-clrnew      Clears the new master key register.
 tke cryptounit-mk-commit      Commits the new master key register.
 tke cryptounit-mk-rotate      Promotes the master key in the new key register to the current key register after rewrapping root keys in the key management keystore.
 tke cryptounit-mk-setimm      Promotes the master key in the new key register to the current key register immediately.
 tke cryptounit-mk-load        Loads the new master key register.
 tke cryptounit-cp-btc         Enables BTC-related functionality in the selected crypto units.
 tke cryptounit-cp-eddsa       Enables Edwards-curve DSA functionality in the selected crypto units.
 tke cryptounit-cp-sig-other   Enables non-ECDSA, non-Edwards-curve signature functionality in the selected crypto units.
 tke auto-init                 Automated initialization of service instances including loading administrators, setting signature thresholds, and random master key generation.
 tke auto-mk-recover           Copies the current master key value in a recovery crypto unit to other crypto units.
 tke auto-mk-rotate            Automated master key rotate using a new randomly generated master key value.
 tke failover-enable           Enables failover cryptounits for an instance. Affects billing, see https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-faq-pricing
TiffanyLiIBM commented 1 year ago

@daniel-butler-irl Thanks for letting us know your finding! The video you were referring to was obsolete. Please find the latest one at: https://mediacenter.ibm.com/media/Getting+started+with+IBM+Cloud+Hyper+Protect+Crypto+Services/1_9mybz1cr. It is also referenced in this topic: https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-initialize-hsm. I will check with the Media Center admin to remove the obsoleted video. Sorry for the confusion!

TiffanyLiIBM commented 1 year ago

The old video has been unpublished from Media Center. Closing this issue.