Skip to content

Commit e9c1a6c

Browse files
authored
fix: add troubleshooting section to docs (#231)
1 parent bcf41eb commit e9c1a6c

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@ A module for provisioning an IBM Cloud Red Hat OpenShift cluster on VPC Gen2. Th
1919
- Make sure that you have a recent version of the [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-getting-started)
2020
- Make sure that you have a recent version of the [IBM Cloud Kubernetes service CLI](https://cloud.ibm.com/docs/containers?topic=containers-kubernetes-service-cli)
2121

22-
23-
2422
## Usage
2523
```hcl
2624
# Replace "master" with a GIT release version to lock into a specific release
@@ -91,9 +89,24 @@ module "ocp_base" {
9189
]
9290
}
9391
}
94-
9592
```
9693

94+
## Troubleshooting
95+
96+
### New kube_version message
97+
98+
- When you run a `terraform plan` command, you might get a message about a new version of Kubernetes, as in the following example:
99+
100+
```terraform
101+
kube_version = "4.12.16_openshift" -> "4.12.20_openshift"
102+
103+
Unless you have made equivalent changes to your configuration, or ignored the relevant attributes using ignore_changes, the following plan may include actions to undo or respond to these changes.
104+
```
105+
106+
A new version is detected because the Kubernetes master node is updated outside of Terraform, and the Terraform state is out of date with that version.
107+
108+
The Kubernetes version is ignored in the module code, so the infrastructure will not be changed. The message identifies only that drift exists in the versions, and after you run a `terraform apply` command, the state will be refreshed.
109+
97110
## Required IAM access policies
98111
You need the following permissions to run this module.
99112

0 commit comments

Comments
 (0)