Skip to content

docs: update README #521

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 19, 2024
Merged

docs: update README #521

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
03ef600
docs: update README
Aashiq-J Sep 18, 2024
7946a65
Update README.md
Aashiq-J Sep 18, 2024
b1e7641
Merge branch 'main' into Aashiq-J-patch-1
ocofaigh Sep 19, 2024
4935b0e
update grep command
Aashiq-J Sep 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ You can manage the default worker pool using Terraform, and make changes to it t

**Terraform Destroy**

When using the default behavior of handling the default worker pool as a stand-alone `ibm_container_vpc_worker_pool`, you must manually remove all worker pools from the Terraform state before running a terraform destroy command on the module. This is due to a [known limitation](https://cloud.ibm.com/docs/containers?topic=containers-faqs#smallest_cluster) in IBM Cloud.
When using the default behavior of handling the default worker pool as a stand-alone `ibm_container_vpc_worker_pool`, you must manually remove the default worker pool from the Terraform state before running a terraform destroy command on the module. This is due to a [known limitation](https://cloud.ibm.com/docs/containers?topic=containers-faqs#smallest_cluster) in IBM Cloud.

Terraform CLI Example

Expand All @@ -140,19 +140,17 @@ For a cluster with 2 worker pools, named 'default' and 'secondarypool', follow t
$ terraform state list | grep ibm_container_vpc_worker_pool
> module.ocp_base.data.ibm_container_vpc_worker_pool.all_pools["default"]
> module.ocp_base.data.ibm_container_vpc_worker_pool.all_pools["secondarypool"]
> module.ocp_base.ibm_container_vpc_worker_pool.pool["default"]
> module.ocp_base.ibm_container_vpc_worker_pool.pool["secondarypool"]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Aashiq-J I think your saying that we only need to run the state remove command on the default worker pool right? So to avoid any confusion, can you make that clear? Perhaps update the grep to only return default pool in its output?

> ...

$ terraform state rm "module.ocp_base.ibm_container_vpc_worker_pool.all_pools[\"default\"]"
$ terraform state rm "module.ocp_base.ibm_container_vpc_worker_pool.all_pools[\"secondarypool\"]"
$ ...
$ terraform state rm "module.ocp_base.ibm_container_vpc_worker_pool.pool[\"default\"]"
```

Schematics Example: For a cluster with 2 worker pools, named 'default' and 'secondarypool', follow these steps:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we even need to mention 'secondarypool' here? Regardless of how many other pools there are or what they are called, your always going to run the state remove command on the default pool right?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes


```sh
$ ibmcloud schematics workspace state rm --id <workspace_id> --address "module.ocp_base.ibm_container_vpc_worker_pool.all_pools[\"default\"]"
$ ibmcloud schematics workspace state rm --id <workspace_id> --address "module.ocp_base.ibm_container_vpc_worker_pool.all_pools[\"secondarypool\"]"
$ ...
$ ibmcloud schematics workspace state rm --id <workspace_id> --address "module.ocp_base.ibm_container_vpc_worker_pool.pool[\"default\"]"
```

**Changes Requiring Re-creation of Default Worker Pool**
Expand Down