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

Document hotfix process for IDAaaS and other platforms #1296

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

cmarooney-stfc
Copy link
Collaborator

@cmarooney-stfc cmarooney-stfc commented Sep 27, 2023

Writeup of processes for modifying IDAaaS deployment of Horace, including notes on SCARF and ISISCompute

@cmarooney-stfc cmarooney-stfc added the DO_NOT_CI Skip CI on this PR label Sep 27, 2023
Comment on lines 8 to 9
- ISISCOMPUTE: This is the base location for code deployed to IDAaaS, and can also be used directly by experienced users only. The section on this below gives reference details
for use of this system.
Copy link
Member

@abuts abuts Sep 27, 2023

Choose a reason for hiding this comment

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

Where it have come from. ISISCOMPUTE is dead now.
All mentions to it should be removed.

One can add instrument machines if you wish to, as example of standard user enviroments. It has been and probably still is enabled there, but this is backup as theses are old weak machines. I used to support them but had not looked into it for ages

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Apologies, my text appears to be based on a clone on 20 Sept, before your changes - don't know how this happened. I will update based on the more recent versions.


#### Contact
This document is primarily concerned with the process of upgrading Horace and releasing new Horace versions on IDAaaS. However, details for how we might update SCARF
and how experienced users would access Horace through ISISCOMPUTE are also given for completeness.
Copy link
Member

Choose a reason for hiding this comment

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

no isiscompute

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

noted


Various versions and components of Horace are deployed in a number of local repositories under the path `/usr/local/mprogs`.

The physical disk location of these Horace repositories is the same as for ISISCOMPUTE system; the description for that system below gives more details.
Copy link
Member

Choose a reason for hiding this comment

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

no isiscompute

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

noted

Various versions and components of Horace are deployed in a number of local repositories under the path `/usr/local/mprogs`.

The physical disk location of these Horace repositories is the same as for ISISCOMPUTE system; the description for that system below gives more details.
As this may change subject to development of the underlying IDAaaS system structure, the path `usr/local/mprogs` provides symbolic links to the repositories' current locations.
Copy link
Member

@abuts abuts Sep 27, 2023

Choose a reason for hiding this comment

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

/usr/local/mprogs -- first slash is important

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

thanks


The principal repositories are
- Horace (underlying name: Horace_git): this is the directory corresponding to `horace_core` in a clone of the full Horace github repository.
- Herbert (underlying name: Herbert_git): this is the directory corresponding to `herbert_core` in a clone of the full Horace github repository.
Copy link
Member

Choose a reason for hiding this comment

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

Herbert repository. Still used but outdated for Horace 4

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@abuts Not clear on this. looking again at the directories in /usr/local/mprogs, the Horace slink point to Horace_git/horace_core, while the Herbert slink points to Herbert_git/herbert_core. The Horace_git path is a clone of the current github repo for Horace, including horace_core and herbert_core, but that herbert_core is not accessed from mprogs. The herbert_core accessed from mprogs is in Herbert_git, which appears to be a cut-down version of the release 3.6.3 branched repo. So it's not clear to me what Herbert content IDAaaS users are getting.

Copy link
Member

@abuts abuts Sep 28, 2023

Choose a reason for hiding this comment

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

Herbert (underlying name: Herbert_git): this is the directory corresponding to herbert_core in a clone of the full Horace github repository.

actually not -- Herbert_git is the clone of Herbert repository, used together with Horace_git repository if Horace_git repositoy contains old version of the Horace, which uses separate Herbert.

Now you probably see why I do not want to write this. I would not be able to understand this sentence.


The following additional repositories in /usr/local/mprogs hold earlier or current release versions
- Horace_3_6 (underlying name Horace_3.6): the current stable release version which is being upgraded to Horace-4
- Horace 3_2 (underlying name Horace; note this is not the same as the symbolically-linked name Horace): preceding historically stable version; not expected to be used
Copy link
Member

@abuts abuts Sep 27, 2023

Choose a reason for hiding this comment

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

I've just asked to remove this so, may be removed

I mean Horace_3_2, and Herbert_3_2 -- this simulinks will be removed, so should not be described

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

For 3.2, guessing it's fine if you remove it. I can remove references. For 3.6, i thought that was the default choice if not switched to v4 so checking you're not going to remove that


#### General deploy comments

The process is currently absolutely the same as on ISISCOMPUTE. The real ISISCOMPUTE and virtual IDAaaS machines are currently share the same OS version
Copy link
Member

Choose a reason for hiding this comment

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

no ISISCOMPUITE

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

yes


hiding technical areas from inexperienced users.
Write access to code repository on iDaaaS is granted by the IDAaaS team on request. Currently the list of people who have write access coincides with
the members of **mslice** group on ISISCOMPUTE. This may change in a future.
Copy link
Member

Choose a reason for hiding this comment

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

no isiscompute

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

yes

For other outputs, please consult with the Horace developers.
- Bring the changes into the IDAaaS repository with the command `git pull`.
- If you have also made changes in the `herbert_core` directory, repeat these steps in the Herbert (Herbert_git) repository.
Although Horace and Herbert have been merged into a single repository on github, they are stilll represented by two separate repositories on IDAaaS.
Copy link
Member

Choose a reason for hiding this comment

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

old versions are still present on `IDAAAS until expected to be used with old versions of Horace

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@abuts As noted above on my comment on line 36, the mprogs/Horace slinks to repo Horace_git (its folder horace_core) which is the latest master or branch from it, while mprogs/Herbert slinks to a different repo Herbert_git (its folder herbert_core) which is branched to the v3.6.3 release. In general I am confused about how Horace and Herbert are paired up.

Copy link
Member

@abuts abuts left a comment

Choose a reason for hiding this comment

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

Normally I hate reading and following step-by step instructions and the addition is a step-by step instruction.
It more or less clear, and the general instructions are there, so could be accepted.
Isiscompute references should be removed. ISISCOMPUTE is in the past. This is the only change which have to be done to this document

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

Successfully merging this pull request may close these issues.

2 participants