Allow users to define custom config for Redis Container #1427

rakesh561 · 2023-05-22T16:14:27Z

Allow users to define custom config for Redis Container

ISSUE TYPE

New or Enhanced Feature

ADDITIONAL INFORMATION

This will address the following issue #1171

Allow users to define custom config for Redis Container

fosterseth · 2023-05-24T18:10:39Z

roles/installer/defaults/main.yml

@@ -286,6 +286,9 @@ web_command: []
 rsyslog_args:
  - /usr/bin/launch_awx_rsyslog.sh
 rsyslog_command: []
+redis_args:
+  - /usr/bin/launch_awx_redis.sh


this file doesn't exist, so I think redis_args can be empty by default

fosterseth · 2023-05-24T18:13:43Z

thanks for this PR, this sounds like the right approach

Does this allow users to drop in a redis.conf file? then the supplied redis command/args would start the redis instance from that config?

can you provide some steps as comment on the PR on what that would look like?

rakesh561 · 2023-05-24T19:34:47Z

@fosterseth I will provide some steps

rakesh561 · 2023-05-26T14:55:40Z

@fosterseth any one who wants to customize redis container can try out following steps.It would be nice if we can run these tests through github actions if possible

apiVersion: v1
kind: ConfigMap
metadata:
name: redis-config
namespace: awx
data:
redis.conf: |
daemonize yes
unixsocket /var/run/redis/redis.sock
unixsocketperm 777
port 0
bind 127.0.0.1
maxmemory 2mb
maxmemory-policy allkeys-lru

spec:
...
  extra_volumes: |
    - name: ansible-cfg
      configMap:
        defaultMode: 420
        items:
          - key: redis.conf
            path: redis.cong
        name: redis-config


  redis_extra_volume_mounts: |
    - name: redis.cfg
      mountPath: /etc/redis.conf
      subPath: redis.conf

  redis_command:
   chmod 755 /etc/redis.conf
   redis-cli start 

 redis_extra_env:
      - name: foo
         value: bar

rakesh561 · 2023-06-01T16:57:21Z

@fosterseth let me know what you think of above inputs or commands.

rakesh561 · 2023-06-22T18:18:38Z

@fosterseth @rooftopcellist just checking to see if you can take a look at it

djyasin · 2023-06-28T18:30:37Z

@rakesh561 Thank you so much for your contribution! It looks like we have some merge conflicts. Would you mind rebasing this PR for us?

rakesh561 · 2023-06-28T19:21:39Z

@djyasin i have done the rebasing.Please let me know how it looks from your end.

roles/installer/templates/deployments/task.yaml.j2

rooftopcellist · 2023-06-28T20:00:36Z

roles/installer/templates/deployments/task.yaml.j2

@@ -382,6 +387,8 @@ spec:
            - name: awx-devel
              mountPath: "/awx_devel"
 {% endif %}
+{% if redis_extra_volume_mounts -%}
+            {{ redis_extra_volume_mounts | indent(width=12, first=True) }}
 {% if termination_grace_period_seconds is defined %}


It looks like the redis_extra_env is missing here:

Suggested change

{% if termination_grace_period_seconds is defined %}

{% if redis_extra_env -%}

{{ redis_extra_env | indent(width=12, first=True) }}

{% endif %}

{% if termination_grace_period_seconds is defined %}

merge conflict needs to be resolved here

@rakesh561 This is still needed

roles/installer/defaults/main.yml

rooftopcellist · 2023-06-28T21:34:43Z

roles/installer/templates/deployments/task.yaml.j2

+          command: {{ redis_command }}
+{% endif %}
+{% if redis_args %}
+          args: {{ redis_args }}          


This line already exists:

https://github.com/ansible/awx-operator/pull/1427/files#diff-4d0fa82fa796130ee45f174f37b43ce5faf7092d12717ad484dbdf712ff24988R155

You'll probably want to set the default to

["redis-server", "/etc/redis.conf"]

I think that should be the value for redis_command, not redis_args, but the only way to know for sure will be to deploy it and try it out once those changes are made.

rooftopcellist · 2023-06-28T21:36:12Z

roles/installer/templates/deployments/web.yaml.j2

+          command: {{ redis_command }}
+{% endif %}
+{% if redis_args %}
+          args: {{ redis_args }}


Same here, this already exists, currently, your templaated redis_args wouldn't be used at all, the entry further down on line 140 would be used instead (here).

rakesh561 · 2023-06-29T01:02:35Z

@rooftopcellist Updated README with example and also applied suggested changes

README.md

Co-authored-by: Christian Adams <rooftopcellist@gmail.com>

rooftopcellist · 2023-07-19T18:31:22Z

config/crd/bases/awx.ansible.com_awxs.yaml

@@ -1566,6 +1574,9 @@ spec:
              web_extra_volume_mounts:
                description: Specify volume mounts to be added to the Web container
                type: string
+              redis_extra_volume_mounts:
+                description: Specify volume mounts to be added to the Redis container
+                type: string
              redis_image:
                description: Registry path to the redis container to use


It looks like redis_extra_env is missing here.

@rakesh561 This is still needed.

Co-authored-by: Christian Adams <rooftopcellist@gmail.com>

TheRealHaoLiu · 2023-08-09T18:06:37Z

roles/installer/templates/deployments/task.yaml.j2

+<<<<<<< HEAD
+=======
+{% endif %}
+>>>>>>> f32bd4e (Updated requested changes)


can you address the merge conflict

TheRealHaoLiu · 2024-01-24T22:11:50Z

https://github.com/ansible/awx-operator/pull/1695/files
try this out and let me know if this implementation allow you to ovverride the things you want

Denney-tech · 2024-01-29T15:15:01Z

@TheRealHaoLiu and @kurokobo , neither of your PR's #1695 or #1697 appear to address modifying the redis.conf file that is mounted to the Redis container. Not everything can be defined as an environment variable, so being able to customize the container specs doesn't necessarily help here.

What we need is a way to modify or replace the settings in redis.conf in the configmap created by the operator, perhaps by adding something like redis_extra_settings: to the awx CRD. Then it could do a dynaconf merge similar to how extra_settings: works.

kurokobo · 2024-01-29T16:08:07Z

@Denney-tech
Yes, you are correct. My and Hao's PRs are focused on pod spec customization, not configmap customization.
As you mentiond changing conf file requires a different way (not sure whether to continue that in this PR or create it as a separate PR).

Denney-tech · 2024-01-29T16:47:15Z

Whatever you brilliant devs think would work the best. :)

Just wanted to reply to Hao's comment that his PR, and in turn yours, didn't satisfy the objective of this PR.

TheRealHaoLiu · 2024-01-31T14:25:09Z

@Denney-tech thanks for checking our our PR and provide valuable feedback

Allow users to define custom config for Redis Container

74aded2

Allow users to define custom config for Redis Container

github-actions bot added the community label May 22, 2023

rakesh561 added 7 commits May 22, 2023 12:21

Update awx-operator.clusterserviceversion.yaml

0657dd5

Update main.yml

64d1458

Update main.yml

118b2e2

Update task.yaml.j2

79550ee

Update web.yaml.j2

c522ded

Update README.md

66def37

Update README.md

8aab276

fosterseth reviewed May 24, 2023

View reviewed changes

rakesh561 added 3 commits May 24, 2023 22:06

Update main.yml

db5a3f3

Update task.yaml.j2

e2e6fe8

Update main.yml

6910970

Merge branch 'devel' into patch-4

88f3d5c

rooftopcellist reviewed Jun 28, 2023

View reviewed changes

roles/installer/templates/deployments/task.yaml.j2 Outdated Show resolved Hide resolved

rakesh561 added 3 commits June 28, 2023 15:52

Update task.yaml.j2

90e4ca0

Update task.yaml.j2

6746551

Update task.yaml.j2

6c6aa76

rooftopcellist reviewed Jun 28, 2023

View reviewed changes

roles/installer/defaults/main.yml Outdated Show resolved Hide resolved

rooftopcellist reviewed Jun 28, 2023

View reviewed changes

Updated requested changes

14f0c34

Added README

8b45aa3

rooftopcellist reviewed Jul 19, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

Update README.md

5a4e4ea

Co-authored-by: Christian Adams <rooftopcellist@gmail.com>

rooftopcellist reviewed Jul 19, 2023

View reviewed changes

Update roles/installer/templates/deployments/task.yaml.j2

4e97be8

Co-authored-by: Christian Adams <rooftopcellist@gmail.com>

TheRealHaoLiu reviewed Aug 9, 2023

View reviewed changes

Denney-tech mentioned this pull request Aug 24, 2023

Switch to using the sclorg redis image for consistency #1531

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow users to define custom config for Redis Container #1427

Allow users to define custom config for Redis Container #1427

rakesh561 commented May 22, 2023 •

edited

Loading

fosterseth May 24, 2023

fosterseth commented May 24, 2023

rakesh561 commented May 24, 2023 •

edited

Loading

rakesh561 commented May 26, 2023

rakesh561 commented Jun 1, 2023

rakesh561 commented Jun 22, 2023

djyasin commented Jun 28, 2023

rakesh561 commented Jun 28, 2023

rooftopcellist Jun 28, 2023

rooftopcellist Jul 19, 2023

rooftopcellist Jul 26, 2023

rooftopcellist Jun 28, 2023

rooftopcellist Jun 28, 2023

rakesh561 commented Jun 29, 2023

rooftopcellist Jul 19, 2023

rooftopcellist Jul 26, 2023

TheRealHaoLiu Aug 9, 2023

TheRealHaoLiu commented Jan 24, 2024

Denney-tech commented Jan 29, 2024 •

edited

Loading

kurokobo commented Jan 29, 2024

Denney-tech commented Jan 29, 2024

TheRealHaoLiu commented Jan 31, 2024

Allow users to define custom config for Redis Container #1427

Are you sure you want to change the base?

Allow users to define custom config for Redis Container #1427

Conversation

rakesh561 commented May 22, 2023 • edited Loading

ISSUE TYPE

ADDITIONAL INFORMATION

Choose a reason for hiding this comment

fosterseth commented May 24, 2023

rakesh561 commented May 24, 2023 • edited Loading

rakesh561 commented May 26, 2023

rakesh561 commented Jun 1, 2023

rakesh561 commented Jun 22, 2023

djyasin commented Jun 28, 2023

rakesh561 commented Jun 28, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rakesh561 commented Jun 29, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TheRealHaoLiu commented Jan 24, 2024

Denney-tech commented Jan 29, 2024 • edited Loading

kurokobo commented Jan 29, 2024

Denney-tech commented Jan 29, 2024

TheRealHaoLiu commented Jan 31, 2024

rakesh561 commented May 22, 2023 •

edited

Loading

rakesh561 commented May 24, 2023 •

edited

Loading

Denney-tech commented Jan 29, 2024 •

edited

Loading