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

-

-

-

-

-

-

Identify components to release

-

1

-

-

-

-

-

-

Release components

1.1

2

-

-

-

-

-

-

2

Create initial SIMP changelog

Examine changes made to the simp-core project since the previous SIMP release tag (e.g., SIMP-6.5.0-1), as well as changes made to its SIMP dependencies listed in the Puppetfile.pinned.

For simp-core changes, examine the following:

• simp-core changes noted in its git logs

• src/assets/simp/build/simp.spec %changelog changes

For changes for an individual SIMP component, examine changes noted both in its git logs and its CHANGELOG file or %changelog section of its build/<component>.spec file. The changes to examine are those from the version listed in the Puppetfile.pinned of the last SIMP release.

simp-doc

8

-

-

-

-

-

-

• This changelog needs to be done early because it informs what release-specific tests need to be executed and which sections of the documentation may need updates.

• This is a tedious, time-consuming job!

• Liz and Jeanne both have utilities to gather the changes.

• The deps:changelog rake task in simp-core should not be used because it does not accurately take into account individual component changes.

Create changelog

6

-

-

-

-

-

-

Review changes

2.1

2

-

-

-

-

-

-

3

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.

Update tests and nodesets

-

4

-

-

-

-

-

-

Review updates

3.2

1

-

-

-

-

-

-

4

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.

Update code and documentation

-

2

-

-

-

-

-

-

Review changes

4.1

1

-

-

-

-

-

-

5

Identify release-specific tests and documentation 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.

2

7

-

-

-

-

-

-

Determine release-specific manual tests

4

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

Identify pages that require an in-depth examination or major revision

2

-

-

-

-

-

-

Create tickets for each test and simp-doc page review

5.1, 5.2

1

-

-

-

-

-

-

6

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, ipa, and simp_lite acceptance test suites pass.

You must set the SIMP_FULL_MATRIX variable to have all the tests run in a GitLab.

simp-core

1, 3

3

-

-

-

-

-

-

Update files and build ISOs for supported OSs

You may need to update package lists for the ISO builds.

-

2

-

-

-

-

-

-

Verify acceptance tests

Verify the default, ipa, and simp_lite acceptance tests pass with new components. No major test revisions should be needed.

6.1

1

-

-

-

-

-

-

Tests should already been updated for major changes in ID 3 in this table.

Review updates

Make sure to verify versions in Puppetfile.pinned, metdata.json and src/assets/simp/build/simp.spec.

6.2

1

-

-

-

-

-

-

7

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

simp-core

6

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.

Build ISO

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

-

1

-

-

-

-

-

-

Publish artifacts

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

7.1

1

-

-

-

-

-

-

8

Validate ISO by building packer boxes (BIOS and UEFI)

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

7

Y

Y

-

-

-

-

8.1

Validate ISO by building packer boxes (BIOS)

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

• BIOS boot box FIPS-enabled, encrypted disk

• BIOS boot box FIPS-enabled, unencrypted disk

• BIOS boot box FIPS-disabled, encrypted disk

• BIOS boot box FIPS-disabled, unencrypted disk

7

Y

Y

-

-

-

-

8.2

Validate ISO by building packer boxes (UEFI)

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

• UEFI boot box FIPS-enabled, encrypted disk

• UEFI boot box FIPS-enabled, unencrypted disk

• UEFI boot box FIPS-disabled, encrypted disk

• UEFI boot box FIPS-disabled, unencrypted disk

9

Verify installation from RPMs in tar file

Run simp-core’s install_from_tar test using the tar file generated from an ISO build.

simp-core

7

-

-

-

-

-

-

-

Execute test

See simp-core/spec/acceptance/suites/README.md at master · simp/simp-core for description of environment variables that can be set to point to the tar file.

1

Y

Y

-

-

-

-

10

Create upgrade instructions

Document any steps that are needed outside of the generic upgrade instructions.  Also look for any unusual messages emitted during RPM upgrade.

simp-doc

7

10

Y

Y

-

-

-

-

Manually execute upgrade with FIPS enabled

4

-

-

-

-

-

-

Manually execute upgrade with FIPS disabled

1

-

-

-

-

-

-

Write upgrade instructions

4

-

-

-

-

-

-

Review instructions

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

10.3

1

-

-

-

-

-

-

11

Verify upgrade instructions

Verify upgrade instructions and make any necessary adjustments to them.

simp-doc

10

Y

Y

-

-

-

-

Execute instructions

2

-

-

-

-

-

-

Update instructions

1

-

-

-

-

-

-

12

Verify PXE boot UEFI

Manually verify clients can PXE boot (UEFI) from a SIMP-managed tftpboot server. SIMP-6925: Add UEFI PXEboot test instructions to simp-docReopened contains links to tickets with descriptions of what others have done previously to test these capabilities.

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

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

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

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

• Verify PXE boot (UEFI) FIPS enabled, disk encrypted, clients from tftpboot server of different OS

7

Y

Y

-

-

-

-

TODO: Automate these tests

13

Verify PXE boot BIOS

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

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

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

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

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

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

7

Y

Y

-

-

-

-

ODO: Finish automation of these tests

14

Verify non-standard ISO UEFI boot options

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

7

Y

Y

-

-

-

-

Verify the choose your own partitions option

-

-

-

-

-

-

Verify the minimum installation option

-

-

-

-

-

-

15

Verify non-standard ISO BIOS boot options

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

7

Y

Y

-

-

-

-

Verify the choose your own partitions option

-

-

-

-

-

-

Verify the minimum installation option

-

-

-

-

-

-

16

Dogfood released modules and assets

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

6

Y

Y

-

-

-

-

Deploy modules to development environments

Update Puppetfiles for development environments and deploy the modules.

-

-

-

-

-

-

Install asset RPMs on SIMP server

Install RPMs and watch for any RPM installation error messages.

-

-

-

-

-

-

Examine logs for issues

16.1, 16.2

-

-

-

-

-

-

17

Execute misc manual tests

Miscellaneous tests that are not addressed (fully) with automation.

6

Y

Y

-

-

-

-

Verify rsyslog local and forwarded logging in simp-core default suite

simp-core's default suite has an extensive rsyslog integration test for local logging and log forwarding that does not use a mock sender ('logger'). Due to rsyslog itself, the rsyslog forwarding verifications have proven to be unreliable. As a stopgap measure, the tests were modified to skip any rsyslog test that fails in the simp-core default suite, in lieu of failing. Unfortunately, this has the potential to hide actual problems. So this ticket is to verify manually that all the failed checks executed in this test actually work.

1

-

-

-

-

-

-

Verify compliance report in simp-core default suite

Examine the compliance report generated by the simp-core default suite and verify there are no incorrect mappings or unexpected non-compliance. (There will be some non-compliance for overrides that allow the test to run.)

1

-

-

-

-

-

-

18

Verify poss scenario

Manually verify SIMP server and a client operate under the expected security measures when the SIMP server is bootstrapped with the ‘poss’ scenario.

Y

Y

-

-

-

-

Verify using a SIMP server and kickstart client with the same OS.

TODO: Automate this test

Bootstrap a SIMP server and verify all security measures are enforced.

-

-

-

-

-

-

Kick a client and verify no security measures are enforced

• If the auditd service is running, it has no rules. ('auditctl -l' returns 'No rules’)

• If the firewalld service is running, the default zone is not the 99_simp zone. ('firewall-cmd --get-default-zone' returns 'public')

• haveged service does not exist. ('systemctl status haveged' returns 'Unit haveged.service could not be found.')

• logrotate configuration, /etc/logrotate.conf, does not have 'include /etc/logrotate.simp.d'

• pam configuration, /etc/pam.d/system-auth does not have "This file managed by Puppet"

• SIMP-specific PKI directories, /etc/pki/simp/ and /etc/pki/simp_apps/, do not exist.

• sssd service should not be running and should not be configured. ( 'systemctl status sssd' returns 'Active: inactive (dead) and there is no/etc/sssd/sssd.conf)

• stunnel service does not exist. ( 'systemctl status stunnel' returns 'Unit stunnel.service could not be found.')

• rsyslog service may be running but is not configured for SIMP, i.e.
  /etc/rsyslog.conf does not have '$IncludeConfig /etc/rsyslog.simp.d/*.conf'

• tcpwrappers is not configured on OSs that support tcpwrappers. (If /etc/hosts.allow exists, it is just comments. Same for /etc/hosts.deny )

-

-

-

-

-

-

19

Benchmark with SCAP scan

This test is intended to find deficiencies in the enforced DISA STIG security settings for SIMP modules

Y

Y

-

-

-

-

Execute scan and analyze results

Execute the SCAP scan on a FIPS-enabled, disk-encrypted SIMP server packer box for which compliance has been enforced and then analyze the results for any SIMP deficiencies. Looking for system configuration that is not correctly configured for which the compliance report does not indicate an exception. Check may reveal component behavior or component compliance data that needs to be updated.

-

-

-

-

-

-

Create tickets for deficiencies

Create tickets for any component deficiencies found.

-

-

-

-

-

-

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

-

-

-

-

-

-

Identify components to release

-

1

-

-

-

-

-

-

Release components

1.1

2

-

-

-

-

-

-

2

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, ipa, and simp_lite acceptance test suites pass.

You must set the SIMP_FULL_MATRIX variable to have all the tests run in a GitLab.

simp-core

1

3

-

-

-

-

-

-

Update files and build ISOs for supported OSs

You may need to update package lists for the ISO builds.

-

2

-

-

-

-

-

-

Verify acceptance tests

Verify the default, ipa, and simp_lite acceptance tests pass with new components. No major test revisions should be needed.

2.1

1

-

-

-

-

-

-

Review updates

Make sure to verify versions in Puppetfile.pinned, metdata.json and src/assets/simp/build/simp.spec.

2.2

1

-

-

-

-

-

-

3

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

simp-core

2

2

Y

Y

-

-

-

-

Build ISO

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

-

1

-

-

-

-

-

-

Publish artifacts

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

3.1

1

-

-

-

-

-

-

4

Validate ISO by building packer boxes (BIOS and UEFI)

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

3

Y

Y

-

-

-

-

4.1

Validate ISO by building packer boxes (BIOS)

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

• BIOS boot box FIPS-enabled, encrypted disk

• BIOS boot box FIPS-enabled, unencrypted disk

• BIOS boot box FIPS-disabled, encrypted disk

• BIOS boot box FIPS-disabled, unencrypted disk

4.2

Validate ISO by building packer boxes (UEFI)

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

• UEFI boot box FIPS-enabled, encrypted disk

• UEFI boot box FIPS-enabled, unencrypted disk

• UEFI boot box FIPS-disabled, encrypted disk

• UEFI boot box FIPS-disabled, unencrypted disk

5

Verify installation from RPMs in tar file

Run simp-core’s install_from_tar test

simp-core

2

-

-

-

-

-

-

-

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

Execute test

See simp-core/spec/acceptance/suites/README.md at master · simp/simp-core for description of environment variables that can be set to point to the tar file

1

Y

Y

-

-

-

-

6

Update Changelog for bug fixes

simp-doc

2

3

-

-

-

-

-

-

Identify bug fixes and update changelog

-

2

-

-

-

-

-

-

Review changes

6.1

1

-

-

-

-

-

-

7

Dogfood released modules and assets

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

2

Y

Y

-

-

-

-

Deploy modules to development environments

Update Puppetfiles for development environments and deploy the modules.

-

-

-

-

-

-

Install asset RPMs on SIMP server

Install RPMs and watch for any RPM installation error messages.

-

-

-

-

-

-

Examine logs for issues

-

-

-

-

-

-

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

NOTE: This excludes simp-doc, which is addressed a separate ticket after all documentation updates have been completed.

-

3

-

-

-

-

-

-

Identify components to release

-

1

-

-

-

-

-

-

Release components

1.1

2

-

-

-

-

-

-

2

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, ipa, and simp_lite acceptance test suites pass.

You must set the SIMP_FULL_MATRIX variable to have all the tests run in a GitLab.

All components in the Puppetfile.pinned except simp-doc should be referencing a GitHub tag. simp-doc is addressed in another ticket.

simp-core

1

3

-

-

-

-

-

-

Update files and build ISOs for supported OSs

You may need to update package lists for the ISO builds.

-

2

-

-

-

-

-

-

Verify acceptance tests

Verify the default, ipa, and simp_lite acceptance tests pass with new components. No major test revisions should be needed.

2.1

1

-

-

-

-

-

-

Review updates

Make sure to verify versions in Puppetfile.pinned, metdata.json and src/assets/simp/build/simp.spec.

2.2

1

-

-

-

-

-

-

3

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.

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

-

-

-

-

-

-

Publish any missing modules to PuppetForge

-

-

-

-

-

-

Update the install_from_core_module test with any release-specific changes

-

-

-

-

-

-

Execute the install_from_core_module test

-

-

-

-

-

-

4

Dogfood released modules and assets

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

2

Y

Y

-

-

-

-

Deploy modules to development environments

Update Puppetfiles for development environments and deploy the modules.

-

-

-

-

-

-

Install asset RPMs on SIMP server

Install RPMs and watch for any RPM installation error messages.

-

-

-

-

-

-

Examine logs for issues

-

-

-

-

-

-

5

Update Changelog for bug fixes

simp-doc

2

3

-

-

-

-

-

-

Identify bug fixes and update changelog

-

2

-

-

-

-

-

-

Review changes

5.1

1

-

-

-

-

-

-

6

Review ‘Quick Start’ Guide

Review and update as necessary. This is a general review to make sure the information is accurate and intelligible.

simp-doc

-

-

-

-

-

-

Review and update

-

-

-

-

-

-

Review changes

6.2

-

-

-

-

-

-

7

Review ‘Getting Started’ Guide

Review and update as necessary. This is a general review to make sure the information is accurate and intelligible.

simp-doc

-

-

-

-

-

-

Review and update

-

-

-

-

-

-

Review changes

7.2

-

-

-

-

-

-

8

Review ‘User Guide’

Review and update as necessary. This is a general review to make sure the information is accurate and intelligible.

simp-doc

-

-

-

-

-

-

Review and update

-

-

-

-

-

-

Review changes

8.2

-

-

-

-

-

-

8.3

Review Upgrade Instructions

Ensure nothing has changed since the original

9

Review ‘HOWTO’

Review and update as necessary. This is a general review to make sure the information is accurate and intelligible.

simp-doc

-

-

-

-

-

-

Review and update

-

-

-

-

-

-

Review changes

9.2

-

-

-

-

-

-

10

Review ‘FAQ’

Review and update as necessary. This is a general review to make sure the information is accurate and intelligible.

simp-doc

-

-

-

-

-

-

Review and update

-

-

-

-

-

-

Review changes

10.2

-

-

-

-

-

-

11

Review ‘Help’ and ‘Contact’ sections

Review and update as necessary. This is a general review to make sure the information is accurate and intelligible.

simp-doc

-

-

-

-

-

-

Review and update

-

-

-

-

-

-

Review changes

11.2

-

-

-

-

-

-

12

Review ‘Glossary of Terms’

Review and update as necessary. This is a general review to make sure the information is accurate and intelligible.

simp-doc

-

-

-

-

-

-

Review and update

-

-

-

-

-

-

Review changes

12.2

-

-

-

-

-

-

13

Review ‘Security Concept of Operations’

Review and update as necessary. This is a general review to make sure the information is accurate and intelligible.

simp-doc

-

-

-

-

-

-

Review and update

-

-

-

-

-

-

Review changes

13.2

-

-

-

-

-

-

14

Review ‘Security Control Mapping’

Review and update as necessary. This is a general review to make sure the information is accurate and intelligible.

simp-doc

-

-

-

-

-

-

Review and update

-

-

-

-

-

-

Review changes

14.2

-

-

-

-

-

-

15

Review ‘Vulnerability Supplement’

Review and update as necessary. This is a general review to make sure the information is accurate and intelligible.

simp-doc

-

-

-

-

-

-

Review and update

-

-

-

-

-

-

Review changes

15.2

-

-

-

-

-

-

16

Finalize simp-doc

Remove any reference to release candidates

Release

16.2

17

Update simp-core with released simp-doc and verify versions

Update simp-core Puppetfile.pinned

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

simp-core

1

3

-

-

-

-

-

-

Update files and build ISOs

-

2

-

-

-

-

-

-

Verify versions

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

17.1

1

-

-

-

-

-

-

TODO: Automate this task

18

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

17

Y

Y

-

-

-

-

Build ISO

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

-

1

-

-

-

-

-

-

Build BIOS boot box with FIPS enabled and encrypted disk

18.1

-

-

-

-

-

-

Build BIOS boot box with FIPS enabled and unencrypted disk

18.1

-

-

-

-

-

-

Build BIOS boot box with FIPS disabled and encrypted disk

18.1

-

-

-

-

-

-

Build BIOS boot box with FIPS disabled and unencrypted disk

18.1

-

-

-

-

-

-

Build UEFI boot box with FIPS enabled and encrypted disk

18.1

-

-

-

-

-

-

Build UEFI boot box with FIPS enabled and unencrypted disk

18.1

-

-

-

-

-

-

Build UEFI boot box with FIPS disabled and encrypted disk

18.1

-

-

-

-

-

-

Build UEFI boot box with FIPS disabled and unencrypted disk

18.1

-

-

-

-

-

-

Publish artifacts

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

18.2, 18.3, 18.4, 18.5, 18.6, 18.7, 18.8, 18.9

1

-

-

-

-

-

-

19

Announce release

5

-

-

-

-

-

-

Announce on mailing lists

-

-

-

-

-

-

20

Post-release: Verify RPM publication

Verify RPMs have been uploaded to simp-project.com. This includes Puppet module RPMs, SIMP application RPMs, and any other auxiliary, application RPMs.

-

-

-

-

-

-

Verify Puppet module RPMs have been published

Execute ‘bundle exec rake puppetfile:check’ and examine output to identify any modules that have not been published to simp-project.com.

-

-

-

-

-

-

Verify other RPMs have been published

Run the install_from_rpm test. See simp-core/spec/acceptance/suites/README.md at master · simp/simp-core . If a nodeset for the OS under test does not exist, create it.

Y

Y

-

-

-

-

Publish any missing RPMs

-

-

-

-

-

-