Secrets Manager CLI per la gestione delle istanze

È possibile utilizzare l'interfaccia della riga di comando (CLI) di gestione delle istanze di IBM Cloud® Secrets Manager per gestire l'istanza dedicata di Secrets Manager Vault dalla riga di comando.

Versione attuale: 2.0.7

Il piano Vault Dedicated è attualmente disponibile in versione beta pubblica. Le funzionalità beta sono fornite a scopo di valutazione e test e presentano alcune limitazioni rispetto alle funzionalità disponibili al pubblico.

Prima di iniziare

Prima di iniziare, installa la CLI di IBM Cloud, quindi installa il plug-in CLI per la gestione delle istanze di Secrets Manager eseguendo il seguente comando:

ibmcloud plugin install secrets-manager-instance-management

Quando sono disponibili aggiornamenti per la CLI di IBM Cloud e per i plug-in, riceverai una notifica sulla riga di comando. Mantieni aggiornata la tua CLI per poter utilizzare i comandi più recenti. Puoi visualizzare la versione corrente di tutti i plugin installati eseguendo ibmcloud plugin list.

Indirizzamento verso un'istanza di Secrets Manager

Per selezionare l'istanza dedicata di Vault dell' Secrets Manager, utilizzare una delle seguenti opzioni.

  • Esegui il comando ibmcloud secrets-manager-instance-management config set .

    ibmcloud secrets-manager-instance-management config set service-url https://{instance_ID}.{region}.secrets-manager.cloud.ibm.com
    
  • Esporta una variabile d'ambiente contenente l'endpoint del servizio del piano di controllo di Secrets Manager: URL.

    export SECRETS_MANAGER_INSTANCE_MANAGEMENT_URL=https://{instance_ID}.{region}.secrets-manager.cloud.ibm.com
    
  • Imposta l'endpoint del servizio nel comando.

    ibmcloud secrets-manager-instance-management instance --service-url https://{instance_ID}.{region}.secrets-manager.cloud.ibm.com
    

Sostituisci {instance_ID} e {region} con i valori relativi alla tua istanza del servizio Secrets Manager Vault Dedicated. Per individuare l'endpoint URL specifico per la tua istanza, puoi copiarlo dalla pagina Endpoint nell'interfaccia utente di Secrets Manager. Per ulteriori informazioni, consulta la sezione " Visualizzazione degli URL degli endpoint ".

Globali

Comandi

ibmcloud secrets-manager-instance-management docs

Apre la documentazione del plug-in nel browser web.

ibmcloud secrets-manager-instance-management docs
Esempio
ibmcloud secrets-manager-instance-management docs

Opzioni

--region (stringa)
La regione in cui hai effettuato il provisioning dell'istanza dedicata di Vault. Regioni disponibili: us-south, eu-de.
--output (stringa)
Selezionare un formato di output - può essere 'json', 'yaml' o 'table'. Il valore predefinito è "table".
-j, --jmes-query (stringa)
Fornire una query JMESPath per personalizzare l'output.
--service-url (stringa)
Fornire l'URL dell'endpoint di base per l'API.
-q, --quiet
Elimina i messaggi dettagliati.
-v, --version
Visualizza la versione del plug-in.

Esempio

ibmcloud secrets-manager-instance-management \
    --region=us-south \
    --output=json \
    --jmes-query="[:10]" \
    --service-url="https://myservice.cloud.ibm.com" \
    --quiet

Questo esempio illustra semplicemente le opzioni globali disponibili per tutti i sottocomandi e non costituisce di per sé un comando valido.

Config

I parametri globali possono anche essere memorizzati in una configurazione persistente, in modo da non doverli specificare manualmente ogni volta che viene richiamato il plug-in. Ogni parametro può essere configurato tramite il comando config e i relativi sottocomandi.

ibmcloud secrets-manager-instance-management config

ibmcloud secrets-manager-instance-management config set

Impostare un nuovo valore di configurazione per un'opzione specifica. Ogni sottocomando del comando set corrisponde a un'opzione globale. Ogni sottocomando accetta un unico argomento, ovvero la rappresentazione sotto forma di stringa del valore da memorizzare per l'opzione.

ibmcloud secrets-manager-instance-management config set <option> <value>

Esempi

ibmcloud secrets-manager-instance-management config set service-url \
    'https://{region}.secrets-manager.cloud.ibm.com'

ibmcloud secrets-manager-instance-management config get

Stampa il valore attualmente impostato per un'opzione specifica. Ogni sottocomando del comando get corrisponde a un'opzione globale.

ibmcloud secrets-manager-instance-management config get <option>

Esempi

ibmcloud secrets-manager-instance-management config get service-url

ibmcloud secrets-manager-instance-management config unset

Annullare l'impostazione del valore attualmente impostato per un'opzione specifica. Ogni sottocomando del comando unset corrisponde a un'opzione globale.

I sottocomandi disponibili per questo servizio sono: service-url,.

ibmcloud secrets-manager-instance-management config unset <option>

Esempi

ibmcloud secrets-manager-instance-management config unset service-url

ibmcloud secrets-manager-instance-management config list

Compilare un elenco di tutti i valori di configurazione attualmente impostati.

ibmcloud secrets-manager-instance-management config list

Esempi

ibmcloud secrets-manager-instance-management config list

Token

Gestisci i token di amministrazione.

ibmcloud secrets-manager-instance-management admin-token-create

Genera un token di amministratore Vault per l'autenticazione al tuo cluster Vault Dedicated. Il token è valido per 1 ora e conferisce privilegi amministrativi. Da utilizzare esclusivamente per la configurazione iniziale e la gestione del cluster; revocare immediatamente dopo l’uso.

ibmcloud secrets-manager-instance-management admin-token-create --id ID [--region REGION] [-j, --jmes-query JMES-QUERY] [--output OUTPUT] [-q, --quiet]

Opzioni comando

--id (stringa)

Secrets Manager ID dell'istanza. Obbligatorio.

La lunghezza deve essere di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.

Esempio

Richiesta di esempio

ibmcloud secrets-manager-instance-management admin-token-create --id bfc50c2e-d66d-4f37-9ccf-9713f8325b39

ibmcloud secrets-manager-instance-management admin-tokens-delete

Revoca tutti i token di amministratore di Vault attivi. Ciò invalida immediatamente tutti i token di amministratore esistenti.

ibmcloud secrets-manager-instance-management admin-tokens-delete --id ID [--region REGION] [-j, --jmes-query JMES-QUERY] [--output OUTPUT] [-q, --quiet]

Opzioni comando

--id (stringa)

Secrets Manager ID dell'istanza. Obbligatorio.

La lunghezza deve essere di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.

Esempio

Richiesta di esempio

ibmcloud secrets-manager-instance-management admin-tokens-delete --id bfc50c2e-d66d-4f37-9ccf-9713f8325b39

Istanze

dell'istanza centrale.

ibmcloud secrets-manager-instance-management instance-details

Ottieni i dettagli dell'istanza del servizio, tra cui lo stato del cluster, gli endpoint e il servizio di gestione delle chiavi.

ibmcloud secrets-manager-instance-management instance-details --id ID [--region REGION] [-j, --jmes-query JMES-QUERY] [--output OUTPUT] [-q, --quiet]

Opzioni comando

--id (stringa)

Secrets Manager ID dell'istanza. Obbligatorio.

La lunghezza deve essere di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.

Esempio

Richiesta di esempio

ibmcloud secrets-manager-instance-management instance-details --id bfc50c2e-d66d-4f37-9ccf-9713f8325b39

Output di esempio

Esempio di risposta dell'istanza

{
  "id" : "12345678-abcd-1234-abcd-1234567890ab",
  "name" : "Example Instance",
  "href" : "https://us-south.secrets-manager.cloud.ibm.com/v2/instances/12345678-abcd-1234-abcd-1234567890ab",
  "instance_crn" : "crn:v1:bluemix:public:secrets-manager:us-south:a/a1b2c3d4e5f61234567890abcdef1234:12345678-abcd-1234-abcd-1234567890ab::",
  "plan" : "dedicated",
  "vault_cluster" : {
    "status" : "healthy",
    "version" : "1.21.2+ent.hsm"
  },
  "endpoints" : {
    "public" : {
      "vault_api" : "https://12345678-abcd-1234-abcd-1234567890ab.us-south.secrets-manager.appdomain.cloud",
      "vault_ui" : "https://12345678-abcd-1234-abcd-1234567890ab.us-south.secrets-manager.appdomain.cloud/ui"
    },
    "private" : {
      "vault_api" : "https://private.12345678-abcd-1234-abcd-1234567890ab.us-south.secrets-manager.appdomain.cloud",
      "vault_ui" : "https://private.12345678-abcd-1234-abcd-1234567890ab.us-south.secrets-manager.appdomain.cloud/ui"
    }
  },
  "encryption" : {
    "mode" : "customer_managed",
    "provider" : "key_protect",
    "key_crn" : "crn:v1:bluemix:public:kms:us-south:a/a1b2c3d4e5f61234567890abcdef1234:abcd1234-ab12-ab12-ab12-abcdef123456:key:12ab34cd-12ab-12ab-12ab-123456abcdef"
  }
}