Document edpm_playbook_environment for proxy configuration #1664
Conversation
Add documentation for configuring environment variables across all data plane playbooks using the edpm_playbook_environment variable. This change adds a new optional step in the data plane node creation procedure that shows how to: - Create a secret containing the edpm_playbook_environment variable with proxy settings - Reference the secret using ansibleVarsFrom with secretRef in the OpenStackDataPlaneNodeSet CR The documentation follows the same pattern as the existing redhat-registry secret example and provides clear instructions for operators who need to configure proxy settings or other environment variables for their data plane deployments. Docs are also added that show using edpm_bootstrap_command to set proxy related environment variables in /etc/profile.d/proxy.sh. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> Jira: OSPRH-15529 Depends-On: openstack-k8s-operators/edpm-ansible#1049 Signed-off-by: James Slagle <jslagle@redhat.com>
slagle
force-pushed
the
edpm_playbook_environment
branch
from
e705f09 to
80c221d
Compare
| === Using `edpm_bootstrap_command` for configuring system proxy settings | ||
|
|
||
| `edpm_bootstrap_command` can be used to configure system proxy settings by | ||
| creating a file under `/etc/profile.d` that defines the proxy environment | ||
| variables. | ||
|
|
||
| ---- | ||
| edpm_bootstrap_command: | | ||
| cat >/etc/profile.d/proxy.sh <<EOF | ||
| export http_proxy="http://USERNAME:PASSWORD@proxy-server.example.com:3128/" | ||
| export https_proxy="http://USERNAME:PASSWORD@proxy-server.example.com:3128/" | ||
| export no_proxy="localhost,127.0.0.1,::1" # Add any hosts to bypass the proxy | ||
| EOF | ||
| ---- |
There was a problem hiding this comment.
Should we not drop this option and text completely as it can be confusing for the user or atleast detail what all situations it won't work. The statement below (won't always apply to tasks executed by ansible) sounds vague to me. I think instead of /etc/profile.d/proxy.sh using environment key value pairs in /etc/environment would always work and we can document that.
There was a problem hiding this comment.
/etc/environment doesn't apply to all processes.
The reason I added this part about still configuring the env vars is to show an example of how to configure a system proxy that would be used by any shell process, such as when the user logs in. I can drop the note about ansible though.
There was a problem hiding this comment.
We need it for ansible tasks right as we're doing it with environment in the play. AFAIK ansible's non-interactive shell would always use /etc/environment.
There was a problem hiding this comment.
As discussed in slack I'll merge it and we revisit it later.
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: rabi, slagle The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-merge-bot
bot
merged commit 476792c
into
openstack-k8s-operators:main
2 participants
Add documentation for configuring environment variables across all
data plane playbooks using the edpm_playbook_environment variable.
This change adds a new optional step in the data plane node creation
procedure that shows how to:
with proxy settings
OpenStackDataPlaneNodeSet CR
The documentation follows the same pattern as the existing
redhat-registry secret example and provides clear instructions
for operators who need to configure proxy settings or other
environment variables for their data plane deployments.
🤖 Generated with Claude Code
Co-Authored-By: Claude noreply@anthropic.com
Jira: OSPRH-15529
Depends-On: openstack-k8s-operators/edpm-ansible#1049
Signed-off-by: James Slagle jslagle@redhat.com