Skip to content
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.

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

Updating initContainers Configuration to Match Pod Specifications #477

Open
Wordbe opened this issue Sep 19, 2024 · 1 comment · May be fixed by #478
Open

Updating initContainers Configuration to Match Pod Specifications #477

Wordbe opened this issue Sep 19, 2024 · 1 comment · May be fixed by #478
Labels
type/enhancement Is an enhancement request
Milestone

Comments

@Wordbe
Copy link

Wordbe commented Sep 19, 2024

Problem description:
The options for initContainers described in the document https://docs.spring.io/spring-cloud-dataflow/docs/current/reference/htmlsingle/#_init_containers differ from the options used in regular Kubernetes pods.
This discrepancy causes confusion for users who are familiar with standard pod syntax.

Solution description:
We request an enhancement of the documentation. Please introduce and explain the various options available for initContainers in the document. Specifically, clarify the following options:

  • containerName (not name)
  • imageName (not image)
  • environmentVariables (not env)

Additionally, it would be helpful to provide an example of how to use these options in a YAML file, such as:

data:
  application.yaml: |-
    spring:
      cloud:
        dataflow:
          task:
            platform:
              kubernetes:
                accounts:
                  default:
                    initContainers:
                      - containerName: test
                        imageName: busybox:latest
                        commands: 
                          - sh
                          - -c
                          - echo hello
                      - containerName: test2
                        imageName: busybox:latest
                        commands:
                          - sh
                          - -c
                          - echo world

Furthermore, please include information about other possible options, such as:

  • imagePullPolicy
  • volumeMounts
  • and others
@github-actions github-actions bot added the status/need-triage Team needs to triage and take a first look label Sep 19, 2024
@ilayaperumalg
Copy link
Contributor

Hi @Wordbe , Thanks for reporting the issue.

Looking at the initContainers configuration, it doesn't look like a discrepancy with the document as the K8s deployer properties are set for the initContainers with containerName and imageName etc., from K8s deployer configuration - not as name and image.

In introspect, this was an unfortunate choice of property name as it would have been simpler to choose the actual K8s initContainer property names. In the upcoming release, we will try to see if we can find a way to consolidate with the actual K8s property keys for better property management.

@corneil corneil transferred this issue from spring-cloud/spring-cloud-dataflow Sep 20, 2024
@cppwfs cppwfs added the type/enhancement Is an enhancement request label Sep 20, 2024
@cppwfs cppwfs added this to the 3.0.x milestone Sep 20, 2024
corneil added a commit to corneil/spring-cloud-deployer that referenced this issue Sep 20, 2024
Updated tests to use old and new names.
Deprecated old names.

Fixes spring-cloud#477
@corneil corneil linked a pull request Sep 20, 2024 that will close this issue
@cppwfs cppwfs removed the status/need-triage Team needs to triage and take a first look label Sep 20, 2024
@Wordbe Wordbe changed the title Update InitContainers Docs Updating initContainers Configuration to Match Pod Specifications Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/enhancement Is an enhancement request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants