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

HPCC-33182 make all helm examples dropzone subpaths to "mydropzone" #19387

Open
wants to merge 2 commits into
base: candidate-9.8.x
Choose a base branch
from

Conversation

xwang2713
Copy link
Member

There are some inconsistences for dropzone subpath in Helm Charts.
Some use "mydropzone" and the others use "dropzone"
Since our regression tests assume "mydropzone" and to make it consistent "mydropzone" will be used.

There is a seperate JIRA https://hpccsystems.atlassian.net/browse/HPCC-33183 for documentation.

Signed off by [email protected]

Type of change:

  • This change is a bug fix (non-breaking change which fixes an issue).
  • This change is a new feature (non-breaking change which adds functionality).
  • This change improves the code (refactor or other change that does not change the functionality)
  • This change fixes warnings (the fix does not alter the functionality or the generated code)
  • This change is a breaking change (fix or feature that will cause existing behavior to change).
  • This change alters the query API (existing queries will have to be recompiled)

Checklist:

  • My code follows the code style of this project.
    • My code does not create any new warnings from compiler, build system, or lint.
  • The commit message is properly formatted and free of typos.
    • The commit message title makes sense in a changelog, by itself.
    • The commit is signed.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly, or...
    • I have created a JIRA ticket to update the documentation.
    • Any new interfaces or exported functions are appropriately commented.
  • I have read the CONTRIBUTORS document.
  • The change has been fully tested:
    • I have added tests to cover my changes.
    • All new and existing tests passed.
    • I have checked that this change does not introduce memory leaks.
    • I have used Valgrind or similar tools to check for potential issues.
  • I have given due consideration to all of the following potential concerns:
    • Scalability
    • Performance
    • Security
    • Thread-safety
    • Cloud-compatibility
    • Premature optimization
    • Existing deployed queries will not be broken
    • This change fixes the problem, not just the symptom
    • The target branch of this pull request is appropriate for such a change.
  • There are no similar instances of the same problem that should be addressed
    • I have addressed them here
    • I have raised JIRA issues to address them separately
  • This is a user interface / front-end modification
    • I have tested my changes in multiple modern browsers
    • The component(s) render as expected

Smoketest:

  • Send notifications about my Pull Request position in Smoketest queue.
  • Test my draft Pull Request.

Testing:

Tested on Docker Desktop environment. This will fix Regress Quick Test pipe8.ecl with "dropzone" as subpath.

Copy link

github-actions bot commented Jan 8, 2025

Jira Issue: https://hpccsystems.atlassian.net//browse/HPCC-33182

Jirabot Action Result:
Workflow Transition To: Merge Pending
Updated PR

@xwang2713 xwang2713 requested review from jakesmith and removed request for Michael-Gardner January 8, 2025 18:35
@@ -40,7 +40,7 @@ planes:
#shareName: datashare
#volumeId: "100-data"
- name: mydropzone
subPath: dropzone
subPath: mydropzone
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

$ ../helm/examples$ fgrep -R dropzone | fgrep -i subpath
fsx/hpcc-fsx-dynamic-pv/values.yaml:  subPath: dropzone
efs/hpcc-efs-dynamic-pv/values.yaml:  subPath: dropzone
efs/hpcc-efs-static-pv/values.yaml:  subPath: dropzone
esdl/values-hpcc-localfile.yaml:  subPath: dropzone
local/hpcc-localfile/values.yaml:  subPath: dropzone
azure/hpcc-azurefile/values.yaml:  subPath: dropzone
nfs/hpcc-nfs/values.yaml:  subPath: dropzone

all subPath's are currently (before this PR) "dropzone", and I think that's logical
In the same way other planes paths, e.g. data are not 'mydata'.

The prefix paths in the generated example files are not consistent though, i.e.:

/helm/examples$ fgrep -R dropzone | fgrep -i prefix
fsx/values-retained-fsx.yaml:    prefix: "/var/lib/HPCCSystems/mydropzone"
efs/values-retained-efs.yaml:    prefix: "/var/lib/HPCCSystems/mydropzone"
efs/values-auto-efs.yaml:    prefix: "/var/lib/HPCCSystems/mydropzone"
esdl/values-echo-example-localfile.yaml:    prefix: "/var/lib/HPCCSystems/dropzone"
local/values-localfile.yaml:    prefix: "/var/lib/HPCCSystems/mydropzone"
azure/values-auto-azurefile.yaml:    prefix: "/var/lib/HPCCSystems/mydropzone"
azure/values-retained-azurefile.yaml:    prefix: "/var/lib/HPCCSystems/mydropzone"

the only that's right is esdl/values-echo-example-localfile.yaml.
I think it would be more consistent to change these to paths to /var/lib/HPCCSystems/dropzone
OR, drop 'my' altogether, use 'dropzone' for the plane name and the subPath (and hence the prefix too).

Copy link
Member

@jakesmith jakesmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@xwang2713 - see comment.

@xwang2713
Copy link
Member Author

OK. I will discuss with Attila

@xwang2713 xwang2713 requested a review from AttilaVamos January 9, 2025 18:47
@xwang2713
Copy link
Member Author

@AttilaVamos is it OK if we use "dropzone" instead of "mydropzone"? I will make change in helm/examples if you agree

@xwang2713
Copy link
Member Author

If we agree to use "mydropzone" I will update following for esdl:

esdl/values-echo-example-localfile.yaml: prefix: "/var/lib/HPCCSystems/dropzone"
esdl/README.md:2. Create subdirectories named dalistorage, debug, dropzone, esdl\echo-example, hpcc-data, queries and sasha.
esdl/values-hpcc-localfile.yaml: subPath: dropzone

@jakesmith
Copy link
Member

jakesmith commented Jan 10, 2025

The configuration/example files in cloud - should not really adhere to old anacronyms (e.g. "my").
NB: this is trivially unimportant, since these are just example files and there's nothing significantly wrong with it as it is, just a small inconsistenty.
[ from Attila's email, the error he saw was not as a result of the inconsistency, just a slight source of confusion, however, most of the planes in our stock environment do not have (and are not are expected to have) the same tail sub-dirs as their plane names. ]

If a change is going to be made to fix this minor inconsistency, it is better to keep the config/examples clean, and in keeping with no longer having, mydali, mythor etc in general, i.e. not introduce more legacy/BM 'my' baggage.

@xwang2713
Copy link
Member Author

Make change from "dropzone" to "mydropzone" for esdl

@xwang2713 xwang2713 requested a review from jakesmith January 10, 2025 17:18
Copy link
Member

@jakesmith jakesmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@xwang2713 - see my previous comments - why are we introducing more 'my'* legacy baggage ? This isn't a change that really needs to be made at all, but if we fix the inconsistency should remove the 'my'*'s not add more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants