1

Release Components

Identify components to be released, verify tests pass, push annotated tags, update SIMP release confluence page. https://simp.readthedocs.io/en/latest/contributors_guide/maintenance/Tagging_and_Releasing_Components.html

-

3

-

-

-

-

-

-

1-1

Identify components to release

-

1

-

-

-

-

-

-

1-2

Release components

1-1

2

-

-

-

-

-

-

10

Create initial SIMP changelog

simp-doc

8

-

-

-

-

-

-

10-1

Create changelog

6

-

-

-

-

-

-

10-2

Review changes

2

-

-

-

-

-

-

2

Update simp-core pre-release tests with release-specific changes

Update simp-core default, ipa, install_from_tar, and simp_lite acceptance test suites for release-specific changes. This includes updating the nodesets and .gitlab-ci.yml for any changes to the supported OSs.

simp-core

-

5

-

-

-

-

-

-

Ideally, this should be done after the initial changelog has been generated, as the changelog informs the work to be done.

Tests will be executed for the appropriate OSs permutations in the nodeset, but separate tickets per OS should not be created.

2-1

Update tests and nodesets

-

4

-

-

-

-

-

-

2-2

Review updates

2-1

1

-

-

-

-

-

-

3

Update simp-packer with release-specific changes

Update simp-packer for release-specific changes. Be sure to tag the previous simp-packer version, if the updates will break testing functionality built for the prior SIMP release.

simp-packer

-

3

-

-

-

-

-

-

Ideally, this should be done after the initial changelog has been generated, as the changelog informs the work to be done.

3-1

Update code and documentation

-

2

-

-

-

-

-

-

3-2

Review changes

3-1

1

-

-

-

-

-

-

11

Identify release-specific tests and document updates

Based on the initial Changelog for the release, identify (1) integration tests that must be done with a fully configured SIMP server and (if necessary) clients and (2) simp-doc documentation that may be affected by the changes. The tests should be tests that are not adequately tested in component acceptance tests.

10

7

-

-

-

-

-

-

11-1

Determine release-specific manual tests

4

11-2

Determine simp-doc pages that need to be reviewed for accuracy

Identify pages that require an indepth examination.

2

-

-

-

-

-

-

11-3

Create tickets for each test and simp-doc page review

1

-

-

-

-

-

-

4

Update simp-core with released components

Update simp-core files (Puppetfile.pinned, metadata.json, src/assets/simp/build/simp.spec) and verify ISOs can be built and the default and ipa acceptance test suites pass.

simp-core

1,2

3

-

-

-

-

-

-

4-1

Update files, build ISOs and execute tests

-

2

-

-

-

-

-

-

4-2

Review updates

4-1

1

-

-

-

-

-

-

5

Create test ISO, and publish the ISO and its tar file

simp-core

4

2

Y

Y

-

-

-

-

This step may actually have to be done several times before we get to an initial release candidate build that can be published. If additional tickets are warranted, they can be created on the fly.

5-1

Build ISO

Use official RPM signing keys when the artifacts are to be published anywhere at simp-project.com.

-

1

Y

Y

-

-

-

-

5-2

Publish artifacts

Interim artifacts may be published to unstable folders at simp-project.com or other unofficial shared locations.

5-1

1

-

-

-

-

-

-

6

Validate ISO by building packer boxes

Use simp-packer to build SIMP server packer boxes. Basic bootstrap validation is done as part of the packer build.

5

Y

Y

-

-

-

-

6-1

Build BIOS boot box with FIPS enabled and encrypted disk

-

-

-

-

-

-

-

6-2

Build BIOS boot box with FIPS enabled and unencrypted disk

-

-

-

-

-

-

-

6-3

Build BIOS boot box with FIPS disabled and encrypted disk

-

-

-

-

-

-

-

6-4

Build BIOS boot box with FIPS disabled and unencrypted disk

-

-

-

-

-

-

-

6-5

Build UEFI boot box with FIPS enabled and encrypted disk

-

-

-

-

-

-

-

6-6

Build UEFI boot box with FIPS enabled and unencrypted disk

-

-

-

-

-

-

-

6-7

Build UEFI boot box with FIPS disabled and encrypted disk

-

-

-

-

-

-

-

6-8

Build UEFI boot box with FIPS disabled and unencrypted disk

-

-

-

-

-

-

-

7

Verify installation from RPMs in tar file

Run simp-core’s install_from_tar test

simp-core

5

-

-

-

-

-

-

-

7-1

Execute test

See https://github.com/simp/simp-core/blob/master/spec/acceptance/suites/README.md for description of environment variables that can be set to point to the tar file

1

Y

Y

-

-

-

-

8

Create upgrade instructions

Document any steps that are needed outside of the generic upgrade instructions. 

simp-doc

4

10

Y

Y

-

-

-

-

8-1

Manually execute upgrade with FIPS enabled

4

-

-

-

-

-

-

8-2

Manually execute upgrade with FIPS disabled

1

-

-

-

-

-

-

8-3

Write upgrade instructions

4

-

-

-

-

-

-

8-4

Review instructions

Review the instructions for clarity, grammar, spelling, formatting, etc. Verification will be done in a separate ticket

1

-

-

-

-

-

-

9

Verify upgrade instructions

Verify upgrade instructions and make any necessary adjustments to them.

simp-doc

8

Y

Y

-

-

-

-

9-1

Execute instructions

2

-

-

-

-

-

-

9-2

Update instructions

1

-

-

-

-

-

-

13

Verify PXE boot UEFI

Manually verify clients can PXE boot (UEFI) from a SIMP-managed tftpboot server

5

Y

Y

-

-

-

-

13-1

Verify PXE boot (UEFI) FIPs enabled, disk encrypted, same OS as tftpboot server

-

-

-

-

-

-

13-2

Verify PXE boot (UEFI) FIPs enabled, disk unencrypted, same OS as tftpboot server

-

-

-

-

-

-

13-3

Verify PXE boot (UEFI) FIPs disabled, disk encrypted, same OS as tftpboot server

-

-

-

-

-

-

13-4

Verify PXE boot (UEFI) FIPs disabled, disk unencrypted, same OS as tftpboot server

-

-

-

-

-

-

13-5

PXE PVerify XE boot (UEFI) FIPs enabled, disk encrypted, clients from tftpboot server of different OS

-

-

-

-

-

-

14

Verify PXE boot BIOS

Manually verify clients can PXE boot (BIOS) from a SIMP-managed tftpboot server

Y

Y

-

-

-

-

14-1

Verify PXE boot (BIOS) FIPs enabled, disk encrypted, same OS as tftpboot server

-

-

-

-

-

-

14-2

Verify PXE boot (BIOS) FIPs enabled, disk unencrypted, same OS as tftpboot server

-

-

-

-

-

-

14-3

Verify PXE boot (BIOS) FIPs disabled, disk encrypted, same OS as tftpboot server

-

-

-

-

-

-

14-4

Verify PXE boot (BIOS) FIPs disabled, disk unencrypted, same OS as tftpboot server

-

-

-

-

-

-

14-5

Verify PXE boot (BIOS) FIPs enabled, disk encrypted, clients from tftpboot server of different OS

-

-

-

-

-

-

15

Verify non-standard ISO UEFI boot options

Manually verify the choose your own partitions and minimum installation ISO boot options

5

Y

Y

-

-

-

-

15-1

Verify the choose your own partitions option

-

-

-

-

-

-

15-2

Verify the minimum installation option

-

-

-

-

-

-

16

Verify non-standard ISO BIOS boot options

Manually verify the ‘choose your own partitions' and ‘minimum installation’ ISO boot options

5

Y

Y

-

-

-

-

16-1

Verify the choose your own partitions option

-

-

-

-

-

-

16-2

Verify the minimum installation option

-

-

-

-

-

-

17

Dogfood released modules and RPMs

Use released modules in development environments that exercise as many of the modules as possible. Use Install RPMs of released assets on SIMP servers.

5

-Y-

Y

-

-

-

-

17-1

Deploy modules and RPMs to development environments

Deploy modules to as many OS variants as possible. Install RPMs to SIMP servers on as many OS variants as possible.

Y

YUpdate Puppetfiles for development environments and deploy the modules.

-

-

-

-

-

-

17-2

Install RPMs on SIMP server

Install RPMs and watch for any RPM installation error messages.

-

-

-

-

-

-

17-23

Examine logs for issues

Y-Y

-

-

-

-

-

1

Release Components

Identify components to be released, verify tests pass, push annotated tags, update SIMP release confluence page. https://simp.readthedocs.io/en/latest/contributors_guide/maintenance/Tagging_and_Releasing_Components.html

-

3

-

-

-

-

-

-

1-1

Identify components to release

-

1

-

-

-

-

-

-

1-2

Release components

1-1

2

-

-

-

-

-

-

4

Update simp-core with released components

Update simp-core files (Puppetfile.pinned, metadata.json, src/assets/simp/build/simp.spec) and verify ISOs can be built and the default and ipa acceptance test suites pass.

simp-core

1

3

-

-

-

-

-

-

4-1

Update files, build ISOs and execute tests

-

2

-

-

-

-

-

-

4-2

Review updates

4-1

1

-

-

-

-

-

-

5

Create test ISO, and publish the ISO and its tar file

simp-core

4

2

Y

Y

-

-

-

-

5-1

Build ISO

Use official RPM signing keys when the artifacts are to be published anywhere at simp-project.com.

-

1

-

-

-

-

-

-

5-2

Publish artifacts

Interim artifacts may be published to unstable folders at simp-project.com or other unofficial shared locations.

5-1

1

-

-

-

-

-

-

6

Validate ISO by building packer boxes

Use simp-packer to build SIMP server packer boxes. Basic bootstrap validation is done as part of the packer build.

5

Y

Y

-

-

-

-

6-1

Build BIOS boot box with FIPS enabled and encrypted disk

-

-

-

-

-

-

-

6-2

Build BIOS boot box with FIPS enabled and unencrypted disk

-

-

-

-

-

-

-

6-3

Build BIOS boot box with FIPS disabled and encrypted disk

-

-

-

-

-

-

-

6-4

Build BIOS boot box with FIPS disabled and unencrypted disk

-

-

-

-

-

-

-

6-5

Build UEFI boot box with FIPS enabled and encrypted disk

-

-

-

-

-

-

-

6-6

Build UEFI boot box with FIPS enabled and unencrypted disk

-

-

-

-

-

-

-

6-7

Build UEFI boot box with FIPS disabled and encrypted disk

-

-

-

-

-

-

-

6-8

Build UEFI boot box with FIPS disabled and unencrypted disk

-

-

-

-

-

-

-

7

Verify installation from RPMs in tar file

Run simp-core’s install_from_tar test

simp-core

5

-

-

-

-

-

-

-

This test can be omitted if there are no changes to component packaging since the previous candidate. Component behavior is adequately tested by the simp-core default suite with each simp-core check-in.

7-1

Execute test

See https://github.com/simp/simp-core/blob/master/spec/acceptance/suites/README.md for description of environment variables that can be set to point to the tar file

1

Y

Y

-

-

-

-

12

Update Changelog for bug fixes

simp-doc

1

3

-

-

-

-

-

-

12-1

Identify bug fixes and update changelog

-

2

-

-

-

-

-

-

12-2

Review changes

12-1

1

-

-

-

-

-

-

17

Dogfood released modules and RPMs

Use released modules in development environments that exercise as many of the modules as possible. Use Install RPMs of released assets on SIMP servers.

5

-Y-

Y

-

-

-

-

17-1

Deploy modules and RPMs to development environments

Deploy modules to as many OS variants as possible. Install RPMs to SIMP servers on as many OS variants as possible.

Y

YUpdate Puppetfiles for development environments and deploy the modules.

-

-

-

-

-

-

17-2

Install RPMs on SIMP server

Install RPMs and watch for any RPM installation error messages.

-

-

-

-

-

-

17-23

Examine logs for issues

Y-Y

-

-

-

-

-

12

Update Changelog for bug fixes

simp-doc

1

3

-

-

-

-

-

-

12-1

Identify bug fixes and update changelog

-

2

-

-

-

-

-

-

12-2

Review changes

12-1

1

-

-

-

-

-

-

21

Review user documentation

General review of user documentation. Intent is to make sure the information is current and intelligible. Does not include ‘Changelog’, ‘Contributing to SIMP’, ‘Security Concept of Operations’, ‘Security Control Mapping’, ‘Vulnerability Supplement’ and ‘License’ sections.

simp-doc

-

-

-

-

-

-

This is required for each major release, nice-to-have for each minor release, and not necessary for each patch release.

Subtasks should correspond to major sections of the documentation, an will need to be updated accordingly when the docs structure changes.

21-1

Review ‘Quick Start’

Review and update as necessary

-

-

-

-

-

-

21-3

Review ‘Getting Started’

Review and update as necessary

-

-

-

-

-

-

21-4

Review ‘User Guide’

Review and update as necessary

-

-

-

-

-

-

21-5

Review ‘HOWTO’

Review and update as necessary

-

-

-

-

-

-

21-6

Review ‘FAQ’

Review and update as necessary

-

-

-

-

-

-

21-7

Review ‘Help’ and ‘Contact’ sections

Review and update as necessary

-

-

-

-

-

-

21-8

Review ‘Glossary of Terms’

Review and update as necessary

-

-

-

-

-

-

22

Review security documentation

General review of security-related documentation. Intent is to make sure the information is current and intelligible.

simp-doc

-

-

-

-

-

-

This is required for each major release, nice-to-have for each minor release, and not necessary for each patch release.

Subtasks should correspond to major sections of the documentation, an will need to be updated accordingly when the docs structure changes.

22-1

Review ‘Security Concept of Operations’

Review and update as necessary

-

-

-

-

-

-

22-2

Review ‘Security Control Mapping’

Review and update as necessary

-

-

-

-

-

-

22-3

Review ‘Vulnerability Supplement’

Review and update as necessary

-

-

-

-

-

-

23

Finalize simp-doc

23-1

Remove any reference to release candidates

23-2

Release

1

Release Components

Identify components to be released, including simp-doc, verify tests pass, push annotated tags, update SIMP release confluence page. https://simp.readthedocs.io/en/latest/contributors_guide/maintenance/Tagging_and_Releasing_Components.html

-

3

-

-

-

-

-

-

1-1

Identify components to release

-

1

-

-

-

-

-

-

1-2

Release components

1-1

2

-

-

-

-

-

-

4

Update simp-core with released components

Update simp-core files (Puppetfile.pinned, metadata.json, src/assets/simp/build/simp.spec) and verify ISOs can be built and the default and ipa acceptance test suites pass.

All components in the Puppetfile.pinned should be referencing a GitHub tag.

simp-core

1

3

-

-

-

-

-

-

4-1

Update files, build ISOs and execute tests

-

2

-

-

-

-

-

-

4-2

Review updates

Make sure there are no version discrepancies in the Puppetfile.pinned, metadata.json and simp.spec files.

4-1

1

-

-

-

-

-

-

18

Verify simp/simp_core meta module

Verify that the simp/simp_core meta module has appropriate dependencies and its dependencies have all been published to PuppetForge by running the install_from_core_module test suite.

4

18-1

Update the install_from_core_module test with any release-specific changes

18-2

Execute check for PuppetForge publication

Execute ‘bundle exec rake puppetfile:check’ and examine output to identify any modules that have not been published to PuppetForge

18-3

Publish any missing modules to PuppetForge

18-4

Execute the install_from_core_module test

17

Dogfood released modules and RPMs

Use released modules in development environments that exercise as many of the modules as possible. Use signed asset RPMs Install RPMs of released assets on SIMP servers.

5-1

Y

Y

-

-

-

-

17-1

Deploy modules and RPMs to development environments

Deploy modules to as many OS variants as possible. Install RPMs to SIMP servers on as many OS variants as possible.

Update Puppetfiles for development environments and deploy the modules.

-

-

-

-

-

-

17-2

Install RPMs on SIMP server

Install RPMs and watch for any RPM installation error messages.

-

-

-

-

-

-

17-3

Examine logs for issues

-

-

-

-

-

-

5

Create final ISO, verify with simp-packer, and publish the ISOs and their tar files

This is the final build and spot check via simp-packer.

simp-core

4

Y

Y

-

-

-

-

5-1

Build ISO

Use official RPM signing keys when the artifacts are to be published anywhere at simp-project.com.

-

1

-

-

-

-

-

-

5-2

Build BIOS boot box with FIPS enabled and encrypted disk

5-1

-

-

-

-

-

-

5-3

Build BIOS boot box with FIPS enabled and unencrypted disk

5-1

-

-

-

-

-

-

5-4

Build BIOS boot box with FIPS disabled and encrypted disk

5-1

-

-

-

-

-

-

5-5

Build BIOS boot box with FIPS disabled and unencrypted disk

5-1

-

-

-

-

-

-

5-6

Build UEFI boot box with FIPS enabled and encrypted disk

5-1

-

-

-

-

-

-

5-7

Build UEFI boot box with FIPS enabled and unencrypted disk

5-1

-

-

-

-

-

-

5-8

Build UEFI boot box with FIPS disabled and encrypted disk

5-1

-

-

-

-

-

-

5-9

Build UEFI boot box with FIPS disabled and unencrypted disk

5-1

-

-

-

-

-

-

5-10

Publish artifacts

Final artifacts that have passed simp-packer validation are published to official release folders at simp-project.com.

5-2, 5-3, 5-4, 5-5, 5-6, 5-7, 5-8, 5-9

1

-

-

-

-

-

-

-

-

-

-

-

-

Y

Y

-

-

-

-

Y

Y

-

-

-

-