docs: Add a note in the README about immutability #388
Conversation
| @@ -22,6 +22,10 @@ encounter bugs, unfinished features, or breaking changes. We encourage you to | |||
| contribute, file issues, and help improve the project as we continue to work on | |||
| it! | |||
|
|
|||
| ### Known limitations | |||
|
|
|||
| ORC does not handle mutability yet. This means that in order to change a resource in OpenStack, you must delete it and recreate it. | |||
There was a problem hiding this comment.
This isn't technically true, we have implemented mutability for the security group rules, so I would rather say that it is only supported for a limited set of resources at the moment and that we haven't had a chance to add mutability for other resources yet (contributions welcome).
For all the fields that do not support mutability yet, we've blocked their update at the API level, meaning that you'll get a clear error message from the kube API server if you ever try to update them.
There was a problem hiding this comment.
For the sake of clarity, I'd go for the simpler statement that mutability is not implemented. As a matter of fact, mutability of the secgroup rules is just an unintended consequence of how we implemented rules.
As mentioned in #275, the fact that we haven't implemented mutability yet should be mentioned in the README.