Skip to content

Commit

Permalink
Add reference environments Troubleshooting
Browse files Browse the repository at this point in the history
  • Loading branch information
dcrossleyau committed May 23, 2024
1 parent 4b8bb34 commit becc5cb
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
2 changes: 2 additions & 0 deletions _faqs/how-to-obtain-refenv-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,5 @@ For example notify yourself, or another person, or notify your team channel.

All members of folio-org are configured to run this job. The service creates a tar file containing the specified logs and uploads to an S3 bucket. A URL to retrieve the logs is returned via a Slack notification.

For failed [Platform hourly build](/guides/automation/#platform-hourly-build) jobs, the Okapi log is linked from the left-hand panel of its Jenkins job summary page.

15 changes: 14 additions & 1 deletion guides/automation.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Similarly okapi can be accessed via `folio-snapshot-core-okapi` (and see notes i
-->

The folio-snapshot and folio-snapshot-2 are constructed identically every 24 hours, with a 12-hour offset.
There are two [flower release](/guides/regular-releases/) environments (the current and the previous) which are rebuilt weekly on a Sunday.
There are also two [flower release](/guides/regular-releases/) environments (the current and the previous) which are rebuilt weekly on a Sunday.

The environments are completely torn-down and rebuilt again.

Expand All @@ -73,6 +73,18 @@ then co-ordinate that on the Slack channel #hosted-reference-envs
in that build's automatically generated [install.json](https://github.com/folio-org/platform-complete/blob/snapshot/install.json) file.
Correlate the "build number" with that shown in the output log of the project's "Publish module descriptor" stage.

### Troubleshooting

Failures with the main builds are automatically sent to the `#hosted-reference-envs` Slack channel.

Follow its links to the Jenkins job output.
Refer to the FAQs
[How to obtain reference environment module logs](/faqs/how-to-obtain-refenv-logs/)
and
[How to investigate Jenkins build logs](/faqs/how-to-investigate-jenkins-logs/)

As noted in the [Platform hourly build](#platform-hourly-build) section below, it is vitally important that developers ensure success of the subsequent hourly build following any major changes that they merge to mainline (especially on a Friday afternoon). Continued failures of this hourly job will cause the “folio-snapshot” builds to use out-of-date install files.

### folio-snapshot

[https://folio-snapshot.dev.folio.org/](https://folio-snapshot.dev.folio.org/)
Expand Down Expand Up @@ -105,6 +117,7 @@ If successful, then this will [regenerate](/guidelines/release-procedures/#add-t
So if there is an urgent need to [rebuild](#off-schedule-rebuilds) "folio-snapshot" outside of normal automation, so as to include a new snapshot of a module, then this build needs to have run before the "folio-snapshot" build is re-run.

It is vitally important that developers ensure success of the subsequent hourly build following any major changes that they merge to mainline (especially on a Friday afternoon). As noted in the previous paragraph, failures of this hourly job will cause the "folio-snapshot" builds to use out-of-date install files.
Refer to the [Troubleshooting](#troubleshooting) assistance section above.

### folio-orchid

Expand Down

0 comments on commit becc5cb

Please sign in to comment.