Update README.md #1197
Merged
Update README.md #1197
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added procedure to disable ipv6 during install or upgrade which was was not mentioned in the doc. SUMMARY By Default deployment tries to enable ipv6 for new install and upgrade.Recently flag was introduced to disable ipv6 but its not mentioned in the README. This will mainly help for people who are trying to upgrade or install awx from AWX 1.1.1 ISSUE TYPE Bug, Docs Fix or other nominal change
README.md
Outdated
| @@ -1285,6 +1286,24 @@ Then install the new AWX Operator by following the instructions in [Basic Instal | |||
|
|
|||
| Once the new AWX Operator is up and running, your AWX deployment will also be upgraded. | |||
|
|
|||
| #### Disable IPV6 for install and upgrade | |||
| Starting with AWX Operator release 0.24.0 ipv6 had been enabled in ngnix configuration which caused upgrades/new install's to fail. | |||
There was a problem hiding this comment.
@rakesh561 I revised this a bit, what do you think?
Starting with AWX Operator release 0.24.0, [IPv6 was enabled in ngnix configuration](https://github.com/ansible/awx-operator/pull/950) which causes upgrades and installs to fail in environments where IPv6 is not allowed. Starting in 1.1.1 release, you can set the `ipv6_disabled` flag on the AWX spec. If you need to use an AWX Operator version between 0.24.0 and 1.1.1 in an IPv6 disabled environment, it is suggested to enable ipv6 on worker nodes.
In order to disable ipv6 on ngnix configuration (awx-web container), add following to the AWX spec.
There was a problem hiding this comment.
@rooftopcellist Updated the requested changes it makes sense.Only thing is unable to make disable ipv6 section highlighted like other sections.
README.md
Outdated
| @@ -1285,6 +1286,24 @@ Then install the new AWX Operator by following the instructions in [Basic Instal | |||
|
|
|||
| Once the new AWX Operator is up and running, your AWX deployment will also be upgraded. | |||
|
|
|||
| #### Disable IPV6 for install and upgrade | |||
There was a problem hiding this comment.
Could we change the name of this section to just Disable IPv6?
There was a problem hiding this comment.
@rooftopcellist Updated the requested changes it makes sense.Only thing is unable to make disable ipv6 section highlighted like other sections.
Submitted the requested suggestions.
README.md
Outdated
| @@ -55,6 +55,7 @@ An [Ansible AWX](https://github.com/ansible/awx) operator for Kubernetes built w | |||
| * [Cluster-scope to Namespace-scope considerations](#cluster-scope-to-namespace-scope-considerations) | |||
| * [Project is now based on v1.x of the operator-sdk project](#project-is-now-based-on-v1x-of-the-operator-sdk-project) | |||
| * [Steps to upgrade](#steps-to-upgrade) | |||
| * [Disable IPV6](#IPV6) | |||
There was a problem hiding this comment.
To make this link work properly, you'll need:
Suggested change
| * [Disable IPV6](#IPV6) | |
| * [Disable IPV6](#disable-ipv6) |
There was a problem hiding this comment.
Thank you very much @rooftopcellist can you please check now.
README.md
Outdated
| @@ -1285,6 +1286,26 @@ Then install the new AWX Operator by following the instructions in [Basic Instal | |||
|
|
|||
| Once the new AWX Operator is up and running, your AWX deployment will also be upgraded. | |||
|
|
|||
| ### Disable IPV6 ### | |||
| Starting with AWX Operator release 0.24.0,[IPV6 was enabled in ngnix configuration](https://github.com/ansible/awx-operator/pull/950) which causes | |||
| upgrades and installs to fail in environments where IPv6 is not allowed. Starting in 1.1.1 release, tou can set the `ipv6_disabled` flag on the AWX | |||
There was a problem hiding this comment.
There is a small typo here:
Suggested change
| upgrades and installs to fail in environments where IPv6 is not allowed. Starting in 1.1.1 release, tou can set the `ipv6_disabled` flag on the AWX | |
| upgrades and installs to fail in environments where IPv6 is not allowed. Starting in 1.1.1 release, you can set the `ipv6_disabled` flag on the AWX |
There was a problem hiding this comment.
Thank you very much @rooftopcellist can you please check now.
Updated the requested changes
|
@rakesh561 Thank you for taking the time to improve the docs! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added procedure to disable ipv6 during install or upgrade which was was not mentioned in the doc.
SUMMARY
ISSUE TYPE
Bug, Docs Fix or other nominal change
SUMMARY
By Default deployment tries to enable ipv6 for new install and upgrade.Recently flag was introduced to disable ipv6 but its not mentioned in the README. This will mainly help for people who are trying to upgrade or install awx from AWX 1.1.1
ISSUE TYPE
Bug, Docs Fix or other nominal change
ADDITIONAL INFORMATION
Users are running into errors with new install and upgrade ever since ipv6 had been introduced to enable