Update CRD definition

Signed-off-by: Luke Mallon (Nalum) <luke.mallon@weave.works>
flux-iac · Aug 2, 2022 · 13b442c · 13b442c
1 parent 9fadb2e
commit 13b442c
Show file tree

Hide file tree

Showing 4 changed files with 98 additions and 2 deletions.
diff --git a/api/v1alpha1/terraform_types.go b/api/v1alpha1/terraform_types.go
@@ -270,10 +270,10 @@ type BackendConfigSpec struct {
 	Disable bool `json:"disable"`
 
 	// +optional
-	SecretSuffix string `json:"secretSuffix"`
+	SecretSuffix string `json:"secretSuffix,omitempty"`
 
 	// +optional
-	InClusterConfig bool `json:"inClusterConfig"`
+	InClusterConfig *bool `json:"inClusterConfig,omitempty"`
 
 	// +optional
 	ConfigPath string `json:"configPath,omitempty"`

diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/infra.contrib.fluxcd.io_terraforms.yaml b/config/crd/bases/infra.contrib.fluxcd.io_terraforms.yaml
@@ -74,6 +74,23 @@ spec:
                     type: object
                   secretSuffix:
                     type: string
+                  state:
+                    description: BackendConfigStateSpec allows the user to set ForceUnlock
+                    properties:
+                      forceUnlock:
+                        description: "ForceUnlock a Terraform state if it has become
+                          locked for any reason. \n Leave this empty to do nothing,
+                          set this to the value of the `Lock Info: ID: [value]`, e.g.
+                          `f2ab685b-f84d-ac0b-a125-378a22877e8d`, to force unlock
+                          the state and finally set this to `auto` to have the state
+                          lock automatically unlocked. \n WARNING: Only use `auto`
+                          in the cases where you are absolutely certain that no other
+                          system is using this state, you could otherwise end up in
+                          a bad place See https://www.terraform.io/language/state/locking#force-unlock
+                          for more information on the terraform state lock and force
+                          unlock."
+                        type: string
+                    type: object
                 type: object
               cliConfigSecretRef:
                 description: SecretReference represents a Secret Reference. It has

diff --git a/docs/References/terraform.md b/docs/References/terraform.md
@@ -81,6 +81,59 @@ map[string]string
 <em>(Optional)</em>
 </td>
 </tr>
+<tr>
+<td>
+<code>state</code><br>
+<em>
+<a href="#infra.contrib.fluxcd.io/v1alpha1.BackendConfigStateSpec">
+BackendConfigStateSpec
+</a>
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+<h3 id="infra.contrib.fluxcd.io/v1alpha1.BackendConfigStateSpec">BackendConfigStateSpec
+</h3>
+<p>
+(<em>Appears on:</em>
+<a href="#infra.contrib.fluxcd.io/v1alpha1.BackendConfigSpec">BackendConfigSpec</a>)
+</p>
+<p>BackendConfigStateSpec allows the user to set ForceUnlock</p>
+<div class="md-typeset__scrollwrap">
+<div class="md-typeset__table">
+<table>
+<thead>
+<tr>
+<th>Field</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>
+<code>forceUnlock</code><br>
+<em>
+string
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>ForceUnlock a Terraform state if it has become locked for any reason.</p>
+<p>Leave this empty to do nothing, set this to the value of the <code>Lock Info: ID: [value]</code>,
+e.g. <code>f2ab685b-f84d-ac0b-a125-378a22877e8d</code>, to force unlock the state and
+finally set this to <code>auto</code> to have the state lock automatically unlocked.</p>
+<p>WARNING: Only use <code>auto</code> in the cases where you are absolutely certain that
+no other system is using this state, you could otherwise end up in a bad place
+See <a href="https://www.terraform.io/language/state/locking#force-unlock">https://www.terraform.io/language/state/locking#force-unlock</a> for more
+information on the terraform state lock and force unlock.</p>
+</td>
+</tr>
 </tbody>
 </table>
 </div>