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

Set runtime shell requirements within Jenkins Pipeline #3171

Merged

Conversation

TerrenceMcGuinness-NOAA
Copy link
Collaborator

@TerrenceMcGuinness-NOAA TerrenceMcGuinness-NOAA commented Dec 16, 2024

Description

This PR updates the Jenkins Pipeline script to source gw_setup.sh from within the PR itself for when ever a shell command is issued that needs it.

Currently the runtime bash shell environment requirements for running the global-workflow (set by sourcing $HOMEgfs/workflow/gw_setup.sh) is established by the user's shell that makes the connection from the Java remote agent to the Jenkins Controller. This update simply sources gw_setup.sh directly during run time when ever needed instead.

NOTE: This does not apply for GitHub CLI and pyGitHub since they are not currently supported by Spack Stack and therefore not incorporated in to gw_setup.sh. These remaining dependances are the responsibility of the role account holders that manage the Jenkins Controller to Node Agent connections.

Type of change

  • Bug fix (fixes something broken)
  • New feature (adds functionality)
  • Maintenance (code refactor, clean-up, new CI test, etc.)

Copy link
Contributor

@AnilKumar-NOAA AnilKumar-NOAA left a comment

Choose a reason for hiding this comment

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

We have added HOMEGFS to the runtime shell environment for gaea C5/C6 both in our epic role account .bashrc file as follows:

Added for Global Workflow

if [ -n "${HOMEGFS+x}" ] && [ -n "${HOMEGFS}" ]; then
source ${HOMEGFS}/workflow/gw_setup.sh
fi

@TerrenceMcGuinness-NOAA TerrenceMcGuinness-NOAA marked this pull request as draft December 17, 2024 18:46
@TerrenceMcGuinness-NOAA
Copy link
Collaborator Author

@AnilKumar-NOAA Oh I see now that you were referring to the .bashrc in the roll account. In a Jenkins Pipeline the shell commands are not login shells but are issued from the shell environment from which the agent had been made to make the connection to the controller. Having said that, I will have to make some adjustments to the wrapper scripts so the needed modules can be set at runtime. Let me make some updates to the wrapper scripts in the CI framework and run some tests from a generic shell. In the meantime this PR has been reverted to a Draft

@TerrenceMcGuinness-NOAA TerrenceMcGuinness-NOAA changed the title Set runtime HOMEgfs in Jenkins to support config.env Set runtime HOMEgfs in Jenkins to support BASH_ENV Dec 20, 2024
@TerrenceMcGuinness-NOAA TerrenceMcGuinness-NOAA added the CI-Orion-Ready **CM use only** PR is ready for CI testing on Orion label Dec 20, 2024
@TerrenceMcGuinness-NOAA TerrenceMcGuinness-NOAA marked this pull request as ready for review December 20, 2024 19:44
@emcbot emcbot added CI-Orion-Building **Bot use only** CI testing is cloning/building on Orion CI-Orion-Running **Bot use only** CI testing on Orion for this PR is in-progress and removed CI-Orion-Ready **CM use only** PR is ready for CI testing on Orion CI-Orion-Building **Bot use only** CI testing is cloning/building on Orion labels Dec 20, 2024
@TerrenceMcGuinness-NOAA TerrenceMcGuinness-NOAA added CI-Orion-Ready **CM use only** PR is ready for CI testing on Orion and removed CI-Orion-Running **Bot use only** CI testing on Orion for this PR is in-progress labels Dec 20, 2024
@emcbot emcbot added CI-Orion-Building **Bot use only** CI testing is cloning/building on Orion CI-Orion-Running **Bot use only** CI testing on Orion for this PR is in-progress and removed CI-Orion-Ready **CM use only** PR is ready for CI testing on Orion CI-Orion-Building **Bot use only** CI testing is cloning/building on Orion labels Dec 20, 2024
@TerrenceMcGuinness-NOAA TerrenceMcGuinness-NOAA added CI-Orion-Ready **CM use only** PR is ready for CI testing on Orion and removed CI-Orion-Running **Bot use only** CI testing on Orion for this PR is in-progress labels Dec 21, 2024
@emcbot emcbot added CI-Orion-Building **Bot use only** CI testing is cloning/building on Orion and removed CI-Orion-Ready **CM use only** PR is ready for CI testing on Orion labels Dec 21, 2024
@emcbot
Copy link

emcbot commented Dec 21, 2024

Checkout Failed on Orion in Build# 6: Could not perform submodule update

@emcbot emcbot added CI-Orion-Failed **Bot use only** CI testing on Orion for this PR has failed and removed CI-Orion-Building **Bot use only** CI testing is cloning/building on Orion labels Dec 21, 2024
@TerrenceMcGuinness-NOAA TerrenceMcGuinness-NOAA removed the CI-Orion-Failed **Bot use only** CI testing on Orion for this PR has failed label Dec 21, 2024
@TerrenceMcGuinness-NOAA TerrenceMcGuinness-NOAA changed the title Set runtime HOMEgfs in Jenkins to support BASH_ENV Set runtime shell requirements within Jenkins Pipeline Dec 26, 2024
@TerrenceMcGuinness-NOAA TerrenceMcGuinness-NOAA added the CI-Orion-Ready **CM use only** PR is ready for CI testing on Orion label Dec 26, 2024
@emcbot emcbot added CI-Orion-Building **Bot use only** CI testing is cloning/building on Orion CI-Orion-Running **Bot use only** CI testing on Orion for this PR is in-progress CI-Orion-Passed **Bot use only** CI testing on Orion for this PR has completed successfully and removed CI-Orion-Ready **CM use only** PR is ready for CI testing on Orion CI-Orion-Building **Bot use only** CI testing is cloning/building on Orion CI-Orion-Running **Bot use only** CI testing on Orion for this PR is in-progress labels Dec 26, 2024
@emcbot
Copy link

emcbot commented Dec 26, 2024

CI Passed on Orion in Build# 1
Built and ran in directory /work2/noaa/stmp/CI/ORION/3171


Experiment C48_ATM_8bafe297 Completed 2 Cycles: *SUCCESS* at Thu Dec 26 11:50:34 AM CST 2024
Experiment C96_S2SWA_gefs_replay_ics_8bafe297 Completed 1 Cycles: *SUCCESS* at Thu Dec 26 12:10:03 PM CST 2024
Experiment C96_atm3DVar_8bafe297 Completed 3 Cycles: *SUCCESS* at Thu Dec 26 01:16:04 PM CST 2024
Experiment C96C48_hybatmDA_8bafe297 Completed 3 Cycles: *SUCCESS* at Thu Dec 26 01:28:23 PM CST 2024
Experiment C48_S2SW_8bafe297 Completed 2 Cycles: *SUCCESS* at Thu Dec 26 02:25:26 PM CST 2024
Experiment C48_S2SWA_gefs_8bafe297 Completed 1 Cycles: *SUCCESS* at Thu Dec 26 02:51:50 PM CST 2024

@TerrenceMcGuinness-NOAA TerrenceMcGuinness-NOAA marked this pull request as ready for review December 26, 2024 21:31
… experment which should be its sole purpose, also did a which on gh incase it is not in ~/bin
Copy link
Contributor

@aerorahul aerorahul left a comment

Choose a reason for hiding this comment

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

changes to source gw_setup.sh are good.
A comment at the end of this PR re. GH might solve the shellnorm error. Please check.
Approve.

Yes, shellnorms spotted this too.

Co-authored-by: Rahul Mahajan <[email protected]>
Copy link
Collaborator Author

@TerrenceMcGuinness-NOAA TerrenceMcGuinness-NOAA left a comment

Choose a reason for hiding this comment

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

committing update to launch script so exit works correctly when gh is not found

Copy link
Contributor

@aerorahul aerorahul left a comment

Choose a reason for hiding this comment

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

looks good.

@TerrenceMcGuinness-NOAA
Just a note here that "launch" is misspelled as "lanuch". Consequently, variables such as JENKINS_AGENT_LAUNCH_DIR is misspelled as JENKINS_AGENT_LANUCH_DIR. Not sure where that variable is defined.

This should probably be corrected in a future PR.

@aerorahul aerorahul merged commit e5d857b into NOAA-EMC:develop Jan 3, 2025
5 checks passed
@aerorahul
Copy link
Contributor

@TerrenceMcGuinness-NOAA
I just merged this PR and got a message about a Hercules jenkins-node.env fail. I hope this PR does not need additional work to be taken on the HPCs

tsga added a commit to tsga/global-workflow that referenced this pull request Jan 4, 2025
* develop:
  Ensure OCNRES and ICERES have 3 digits in the archive script (NOAA-EMC#3199)
  Set runtime shell requirements within Jenkins Pipeline (NOAA-EMC#3171)
  Add efcs and epos to ufs_hybatm xml (NOAA-EMC#3192) (NOAA-EMC#3193)
  Fix GEFS and SFS compile flags in build_all.sh (NOAA-EMC#3197)
  Remove early-cycle EnKF forecast (NOAA-EMC#3185)
  Fix mod_icec bug in atmos_prod (NOAA-EMC#3167)
  Create compute build option (NOAA-EMC#3186)
  Support global-workflow using Rocky 8 on CSPs (NOAA-EMC#2998)
danholdaway added a commit to danholdaway/global-workflow that referenced this pull request Jan 27, 2025
* develop:
  Remove WAFS files and references from `develop` (NOAA-EMC#3263)
  fix intel stack version number on c5 (NOAA-EMC#3258)
  Update gsi_monitor and ufs_utils hashes to recent hashes for C5/C6 build and run (NOAA-EMC#3252)
  Enable DA cycling on gaea C5/C6 (NOAA-EMC#3255)
  Copy post-processed sea ice increment for diagnostics (NOAA-EMC#3235)
  Only run METplus in the 3Dvar tests (NOAA-EMC#3245)
  Clone, build, and run C48_ATM and C48_S2SW on Gaea C5 and C6 (NOAA-EMC#3106)
  Add echgres as a dependency only for RUN=enkfgdas, not enkfgfs (NOAA-EMC#3246)
  Add domain level to wave gridded COM path (NOAA-EMC#3137)
  CI JJOB Tests using CMake (NOAA-EMC#3214)
  Make assorted updates to waves (NOAA-EMC#3190)
  Move WCOSS2 LD_LIBRARY_PATH patches to load_ufsda_modules.sh (NOAA-EMC#3236)
  Adding a gefs_arch task to GEFS workflow (NOAA-EMC#3211)
  Add additional GEFS variables needed for AI/ML applications  (NOAA-EMC#3221)
  Add bmat task dependency to marine LETKF task (NOAA-EMC#3224)
  Resolve bug with LMOD_TMOD_FIND_FIRST setting affecting build on WCOSS2 (NOAA-EMC#3229)
  Reinstate product groups (NOAA-EMC#3208)
  Additional fixes for downstream jobs (NOAA-EMC#3187)
  Turn IAU off during staging job for cold start experiments (NOAA-EMC#3215)
  Update the gdas.cd hash and enable GDASApp to run on WCOSS2 (NOAA-EMC#3220)
  Update upload-artifact to v4 (NOAA-EMC#3216)
  Prevent duplicate case generation in generate_workflows.sh (NOAA-EMC#3217)
  Update g-w to cycle with C1152 ATM (NOAA-EMC#3206)
  Separate use of initial increment/perturbation file from REPLAY/+03 ICs  (NOAA-EMC#3119)
  Update gsi_enkf hash and gsi_ver (NOAA-EMC#3207)
  Remove cpus-per-task from APRUN_OCNANALECEN on WCOSS2 (NOAA-EMC#3212)
  Remove 5WAVH from AWIPS GRIB2 parm files (NOAA-EMC#3146)
  Remove multi-grid wave support (NOAA-EMC#3188)
  Add echgres as a dependency for earc (NOAA-EMC#3202)
  Ensure OCNRES and ICERES have 3 digits in the archive script (NOAA-EMC#3199)
  Set runtime shell requirements within Jenkins Pipeline (NOAA-EMC#3171)
  Add efcs and epos to ufs_hybatm xml (NOAA-EMC#3192) (NOAA-EMC#3193)
  Fix GEFS and SFS compile flags in build_all.sh (NOAA-EMC#3197)
  Remove early-cycle EnKF forecast (NOAA-EMC#3185)
  Fix mod_icec bug in atmos_prod (NOAA-EMC#3167)
  Create compute build option (NOAA-EMC#3186)
  Support global-workflow using Rocky 8 on CSPs (NOAA-EMC#2998)
  Change orog gravity wave drag scheme for grid sizes less than 10km (NOAA-EMC#3175)
  Switch snow DA to use 2DVar for deterministic and ensemble mean (NOAA-EMC#3163)
  Update compression options for GEFS history files (NOAA-EMC#3184)
  Update compression options for high res history files (NOAA-EMC#3178)
  Turn DO_TEST_MODE off (NOAA-EMC#3177)
  Hotfix for gdas_arch div/0 (NOAA-EMC#3169)
  Allow building of the ufs-weather-model, WW3 pre/post execs for GFS, GEFS, SFS in the same clone of global-workflow (NOAA-EMC#3098)
  Switch Aerosol DA to use JCB and Jedi class (NOAA-EMC#3125)
  Update ufs-weather-model to 2024-12-06 commit  (NOAA-EMC#3145)
  Enable traditional threading as an option (NOAA-EMC#3149)
  Update HPC_ACCOUNT on Hercules to fv3-cpu (NOAA-EMC#3164)
  Turn C96C48_ufs_hybatmDA and C48mx500_3DVarAOWCDA into a regression test (NOAA-EMC#3120)
  Update GSI analysis jobs to use COMIN/COMOUT (NOAA-EMC#3092)
  Update HPC Tier Definitions (NOAA-EMC#3138)
  Add marine hybrid envar (NOAA-EMC#3041)
  Archive the experiment directory along with git status/diff output (NOAA-EMC#3105)
  Use stochastic restart patterns on rerun (NOAA-EMC#3077)
  Point Jenkinsfile back to CI/ (NOAA-EMC#3139)
  Fix wave restart for cold start and add ic version file (NOAA-EMC#3112)
  Allow users to override the default account at setup time (NOAA-EMC#3127)
  Refactor gridded wave post (NOAA-EMC#3014)
  Update docs related to NOAA CSPs (NOAA-EMC#3043)
  Allow APP to differ between RUNs (NOAA-EMC#2943)
  Run one executable for soca2cice (instead of two) (NOAA-EMC#3118)
  Speed up GSI analysis jobs in CI testing (NOAA-EMC#3115)
  Make aerosol output frequency variable (NOAA-EMC#2982)
  Add new stations to GFS BUFR sounding products (NOAA-EMC#3107)
  JCB-based obs+bias staging, Jedi class updates, and marine B-matrix refactoring (NOAA-EMC#2992)
  Enable tapering of atm ens perts at the model top (NOAA-EMC#3097)
  Update JGDAS ENKF POST  job  (NOAA-EMC#3090)
  SFS Runs at C96mx100  (NOAA-EMC#2960)
  Move machine-based options from config.base to host files (NOAA-EMC#3053)
  Remove RUNDIRS before running CI cases to cover re-run events (NOAA-EMC#3076)
  CI GitHub pipeline (hotfix) update for fetching repo name (NOAA-EMC#3084)
  Update JGDAS ENKF ECEN job  (NOAA-EMC#3050)
  Update snow obs processing job (NOAA-EMC#3055)
  Update to action workflow pipeline in default repo for development  (NOAA-EMC#3062)
  Update to action workflow pipeline in default repo for development (NOAA-EMC#3061)
  Update workflow pipeline (NOAA-EMC#3060)
  PW CI pipeline update5 ready for review so it can be merged and tested (NOAA-EMC#3059)
  Revert "GitHub CI Pipeline update for debugging forked PR support" (NOAA-EMC#3057)
  GitHub CI Pipeline update for debugging forked PR support (NOAA-EMC#3056)
  Add more ocean variables for post-processing in GEFS (NOAA-EMC#2995)
  Auto provisioning of PW clusters from GitHub CI added (NOAA-EMC#3051)
  Fix the name of the TC tracker filenames in archive.py (NOAA-EMC#3030)
  Make wxflow links static instead of from link_workflow (NOAA-EMC#3008)
  Update global jdas enkf diag job with COMIN/COMOUT for COM prefix (NOAA-EMC#2959)
  Add run and finalize methods to marine LETKF task (NOAA-EMC#2944)
  Fix wave restarts and GEFS FHOUT/FHMAX (NOAA-EMC#3009)
  Disabling hyper-threading (NOAA-EMC#2965)
  GitHub Actions Pipeline Updates for Self-Hosted Runners on PW (NOAA-EMC#3018)
  CI jekninsfile update hotfix (NOAA-EMC#3038)
  Update gdas.cd (NOAA-EMC#2978)
  Add ability to add tag to pslots with generate_workflows (NOAA-EMC#3036)
  CI update to shell environment with HOMEgfs to HOME_GFS for systems that need the path (NOAA-EMC#3013)
  Quick updated to Jenkins (health check) launch script (NOAA-EMC#3033)
  Document the generate_workflows.sh script (NOAA-EMC#3028)
  Replace gfs_cyc with an interval (NOAA-EMC#2928)
  Hotfix: Fix generate_workflows.sh optional build flags (NOAA-EMC#3024)
  Add a tool to run multiple YAML cases locally (NOAA-EMC#3004)
  Hotfix: Correctly set overwrite option when specified (NOAA-EMC#3021)
@TerrenceMcGuinness-NOAA TerrenceMcGuinness-NOAA deleted the jenkins_node.env branch January 29, 2025 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD Issue related to CI/CD CI-Orion-Passed **Bot use only** CI testing on Orion for this PR has completed successfully
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants