Todo
Deployment involves the following:
note - We may need 3 places, dev / test / prod for deployment to go, and if we can could create a lightweight override that would be helpful for a temporary test location possibly using local screeniocs component
How deployment works currently (for a brand new app, for an existing app its the same steps minus a few):
Add your project to eco
$ git clone /afs/slac/g/cd/swe/git/repos/slac/buildtools/eco_modulelist.git $ cd eco_modulelist $ vi modulelist.txt # Add your line <project-name> <path-to-project-repo-.git> # Push to eco repo $ git add modulelist.txt $ git commit -m "Added <project-name> to eco." $ git push # Pull from eco repo remote $ cd $TOOLS/eco_modulelist $ git pull
Add your project to cram
$ cd <project-name>/<project-name>-git $ cram describe # This should open a prompt to enter the project name and type. Then will create .cram information # Commit the .cram $ git add .cram $ git commit -m "Add cram functionality" $ git push # Can test with $ cram ls
Add your component to $EPICS_IOC_TOP (/afs/slac/g/lcls/epics/iocTop)
$ cd $EPICS_IOC_TOP # make directory for your app if doesn't exist $ mkdir <app> && cd <app> # Create symlink to point to a tag, in this case it doesn't exist # TODO: not sure if this part works cant find docs on brand new app $ ln -s <app>-<tag> current # Make a softlink to the folder
Add your IOC to $IOC (/afs/slac/g/lcls/epics/iocCommon)
# Create the directory $ cd $IOC && mkdir <ioc> # Create symlink to point to the symlink you made before $ cd <ioc> && ln -s ../../iocTop/<app>/current iocSpecificRelease # Add in the startup.cmd
After finishing changes to component, tag it like R1.0.1, push the tag
$ git tag <tag name> # Create a tag. Your tag should follow the RX.Y.Z convention. $ git push origin <tag name> # Push a tag to a shared server. $ git push origin --tags # If you have a lot of tags that you want to push up at once. This will push all of your tags to the remote server that are not already there.
Now ready to push to the deployment locations in all facilities using cram push
[mshankar@lcls-dev2 MatlabSupport-R3-2-0-0]$ cram push Pushed release MatlabSupport-R3-2-0-0 to LCLS ...
(adbs-env) [pnispero@sdfiana018 test-ioc]$ bs run deployment
Checking current directory if a component...
INFO-root:[run_commands.py:36 - parse_manifest() ] {'format': 1, 'repo': 'test-ioc', 'organization': 'ad-build-test', 'build': 'build.sh', 'deploy': 'test-deployment.yaml', 'environments': ['rocky9', 'rhel7'], 'dependencies': [{'epics-base': 'R7.0.3.1-1.0'}, {'asyn': 'R4.39-1.0.1'}], 'python': 'requirements.txt'}
== ADBS == At the moment, deployment only for IOCs is supported
== ADBS ==
****** if testing please source BuildSystem/other/test-env.bash ******
[?] Specify type of deployment:
> DEV
PROD
[?] Specify type of ioc:
> SIOC
HIOC
VIOC
[?] Initial deployment?:
> True
False
[?] Specify name of ioc to deploy: sioc-test-bs
[?] Specify host user account used to run screen
(ex: laci@lcls-dev1): adbuild
[?] Specify executable path
(ex:/afs/slac/g/lcls/epics/iocCommon/sioc-sys0-al02/iocSpecificRelease/bin/rhel7-x86_64/alhPV): /sdf/home/p/pnispero/tes
t-ioc
{'initial': 'True', 'component_name': 'test-ioc', 'deploy_type': 'DEV', 'user': 'pnispero', 'iocTop': '/sdf/scratch/ad/build/lcls/epics/iocTop', 'iocCommon': '/sdf/scratch/ad/build/lcls/epics/iocCommon', 'iocData': '/sdf/scratch/ad/build/lcls/epics/ioc/data', 'ioc_type': 'SIOC', 'ioc_name': 'sioc-test-bs', 'host_user': 'adbuild', 'server_user_node_port': 'None', 'executable_path': '/sdf/home/p/pnispero/test-ioc', 'output_path': '/sdf/home/p/pnispero/test-ioc/ADBS_TMP'}
[WARNING]: No inventory was parsed, only implicit localhost is available
[WARNING]: provided hosts list is empty, only localhost is available. Note that
the implicit localhost does not match 'all'
PLAY [localhost] ***************************************************************
TASK [Gathering Facts] *********************************************************
ok: [localhost]
PLAY [Initial IOC Deployment] **************************************************
TASK [Gathering Facts] *********************************************************
ok: [localhost]
TASK [Add component to $EPICS_IOC_TOP] *****************************************
ok: [localhost]
TASK [Create sioc directory in $IOC if it doesn't exist] ***********************
changed: [localhost]
TASK [Create symbolic link for iocSpecificRelease for DEV] *********************
changed: [localhost]
TASK [Create symbolic link for iocSpecificRelease for PROD] ********************
skipping: [localhost]
TASK [Create sioc directory in $IOC_DATA if it doesn't exist] ******************
changed: [localhost]
TASK [Create multiple directories in $IOC_DATA/sioc-test-bs if they doesn't exist] ***
changed: [localhost] => (item=/sdf/scratch/ad/build/lcls/epics/ioc/data/sioc-test-bs/archive)
changed: [localhost] => (item=/sdf/scratch/ad/build/lcls/epics/ioc/data/sioc-test-bs/autosave)
changed: [localhost] => (item=/sdf/scratch/ad/build/lcls/epics/ioc/data/sioc-test-bs/autosave-req)
changed: [localhost] => (item=/sdf/scratch/ad/build/lcls/epics/ioc/data/sioc-test-bs/iocInfo)
changed: [localhost] => (item=/sdf/scratch/ad/build/lcls/epics/ioc/data/sioc-test-bs/restore)
changed: [localhost] => (item=/sdf/scratch/ad/build/lcls/epics/ioc/data/sioc-test-bs/yaml)
PLAY RECAP *********************************************************************
localhost : ok=7 changed=4 unreachable=0 failed=0 skipped=1 rescued=0 ignored=0
successful: 0
(adbs-env) [pnispero@sdfiana018 test-ioc]$
Update:
Wanted to highlight the differences between deploying with CRAM vs new bs (build system) deployment
I have got a working prototype of a deployment Build and Deploy build results for IOC app · Issue #7 · ad-build-test/BuildSystem (github.com, and I've almost finished points 1-4. Among other things, the deployment aspect of this new system consolidates all cram and manual steps to just one command.
What - When a developer needs to host their app on a certain test stand(s). So, they can test functionality.
When - Anytime a developer wants to test, or automatically done on pushes to main branch / pull requests
How - Options:
What - When an app is updated for bug fix / feature, code reviewed, tested through build system, scheduled in PAMM, is now ready to deploy in production.
When - When an app is code reviewed, tested, scheduled to release.
How - Options:
Notes:
9-6-2024 discussion of functionality wanted