- コマンドライン
- 基本的なCLI機能
- コマンド: workspace
- コマンド: workspace delete
コマンド: workspace delete
tofu workspace delete
コマンドは、既存のワークスペースを削除するために使用されます。
使用法
使用法: tofu workspace delete [OPTIONS] NAME [DIR]
このコマンドは、指定されたワークスペースを削除します。
ワークスペースを削除するには、そのワークスペースがすでに存在し、リソースを追跡しておらず、現在のワークスペースでない必要があります。ワークスペースがリソースを追跡している場合、OpenTofuは-force
フラグが指定されていない限り、削除を許可しません。
さらに、異なるバックエンドは、ワークスペースが-force
フラグなしで安全に削除できるかどうかについて、ワークスペースがロックされているかどうかなど、他の制限を実装する場合があります。
リソースを追跡しているワークスペースを(-force
経由で)削除すると、リソースが「宙に浮いた」状態になる可能性があります。これらは物理的に存在するものの、OpenTofuが管理できなくなったリソースです。これは、OpenTofuにリソースの管理を停止させて、別の方法で管理できるようにする場合など、望ましい場合があります。しかし、ほとんどの場合、これは意図されたものではないため、OpenTofuはこの状況に陥るのを防ぎます。
モジュールソース、バックエンド構成、または暗号化ブロックでの変数の使用には、tofu workspace delete
の実行時にルートモジュール変数に値を割り当てる必要があります。
コマンドラインフラグはすべてオプションです。サポートされているフラグは次のとおりです。
-
-force
- リソースを追跡している場合でも、ワークスペースを削除します。削除後、OpenTofuはワークスペースのインフラストラクチャを追跡または管理できなくなります。デフォルトはfalseです。 -
-lock=false
- 操作中に状態ロックを保持しません。これは、他の人が同じワークスペースに対してコマンドを同時に実行する可能性がある場合、危険です。 -
-lock-timeout=DURATION
- 状態ロックを再試行する期間。デフォルトは0秒です。 -
-var 'NAME=VALUE'
- 設定のルートモジュールで宣言された単一の入力変数の値を設定します。複数の変数を設定するには、このオプションを複数回使用します。詳細については、コマンドラインでの入力変数を参照してください。 -
-var-file=FILENAME
- "tfvars"ファイルからの定義を使用して、設定のルートモジュールで宣言された多数の入力変数の値を設定します。複数のファイルから値を含めるには、このオプションを複数回使用します。
ルートモジュールの入力変数の値を設定するには、-var
および-var-file
オプション以外にもいくつかの方法があります。詳細については、ルートモジュール変数への値の割り当てを参照してください。
例
$ tofu workspace delete example
Deleted workspace "example".