Skip to content

Commit

Permalink
Release galaxy-2.6.1
Browse files Browse the repository at this point in the history
Signed-off-by: kksat <22549266+kksat@users.noreply.github.com>
  • Loading branch information
kksat committed Oct 30, 2024
1 parent 75fb131 commit 8c06cf7
Show file tree
Hide file tree
Showing 8 changed files with 401 additions and 982 deletions.
1,273 changes: 319 additions & 954 deletions docs/CHANGELOG.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion galaxy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ namespace: sap

name: sap_operations

version: 2.6.0
version: 2.6.1

readme: README.md

Expand Down
38 changes: 38 additions & 0 deletions roles/download/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,12 @@ Role is idemponent - bits that are already downloaded will not be downloaded aga
Idempotency is working by comparing SHA256 checksum for local files and files to be downloaded.
Role is checking if there is sufficient space available in destination folder.
Destination folder (variable `download_destination`) should already exist.
If destination folder does not exist, not directory or not writeable role will fail
For each file downloaded there is SHA256 checksum available on SAP SWDC, this checksum will be validated.
This is ensure that bits are downloaded correctly and were not tampered with.
SSL certificate is also checked when bits are downloaded, see download_validate_certs variable below.

By default role will download only one file with latest ReleaseDate, see parameters download_sort_attribute and download_one_file
Role return variables
**download_register_last**
Variable is set by the role and and available after role has been executed.
Expand Down Expand Up @@ -150,6 +152,12 @@ Should exists before role execution.
Ansible user should have write permission to this destination folder.
Role will check if there is sufficient space available on device.
If not role will fail with information about space requirements.
Ansible module ansible.builtin.uri is used to download SAP software from SWDC
This module downloads temp files to ansible_remote_tmp folder,
this folder has to have space to download largest file, if not - not enough space
error will be raised by Ansible.
See https://docs.ansible.com/ansible/latest/collections/ansible/builtin/sh_shell.html#parameter-remote_tmp
and https://docs.ansible.com/ansible/latest/collections/ansible/builtin/sh_shell.html#parameter-system_tmpdirs



Expand Down Expand Up @@ -255,6 +263,7 @@ _Required:_ `False`
_Choices:_
- x86_64
- ppc64le
- arm64
_Description:_
Architecture for which SAP software will be downloaded.
Not required, if not set will be set to architecture from `ansible_facts['architecture']`
Expand Down Expand Up @@ -322,4 +331,33 @@ _Description:_
Permissions that will be set for downloaded files.



#### download_sort_attribute


_Type:_ `str`

_Default:_ `ReleaseDate`

_Required:_ `False`
_Choices:_
- ReleaseDate
- ChangeDate
_Description:_
Attribute used to sort list of items to download



#### download_one_file


_Type:_ `bool`

_Default:_ `True`

_Required:_ `False`
_Description:_
If at most one file has to be downloaded



2 changes: 0 additions & 2 deletions roles/downloadbasket/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,7 @@ For each file downloaded there is SHA256 checksum available on SAP SWDC, this ch
This is ensure that bits are downloaded correctly and were not tampered with.
Checksum and filename will be used to skip files with same filename and sha256 checksum if they are already available in downloadbasket_destination


Role return variables:
======================
**downloadbasket_register**
Variable is set (using set_fact) by the role and and available after role has been executed.
Variable contains information about last downloaded content from SAP SWDC download basket
Expand Down
20 changes: 17 additions & 3 deletions roles/general_preconfigure/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,10 @@ How reboot has to be handled
none - no reboot will be be required after role applied,
role will not install packages that might require reboot. Not all requirements can be fulfilled that way.
List of packages to be skipped see <https://access.redhat.com/solutions/27943>
postpone - (default behavior) reboot might be required after packages installation by the role,
role will not reboot machine, role will not notify reboot action, in this case reboot has to be handled separately by the user.
now - role will force reboot of the host at the end of the execution - this is not idempotent and reboot will be forced each time role is executed.
postpone - (default behavior) role will not flush handlers at the end of execution, but reboot handler will be notified,
in this case this is a user obligation to flush handlers (and thus reboot the host).
now - role will flush handlers at the end of the execution - this is might not be desirable,
in situations when another role that requires reboot will run after.



Expand All @@ -73,6 +74,19 @@ _Description:_
Size of tmpfs to configure (in gigabytes)



#### general_preconfigure_reboot_timeout


_Type:_ `int`

_Default:_ `3600`

_Required:_ `False`
_Description:_
Timeout for reboot handler, see how reboot is handled in general_preconfigure_reboot parameter description




## Limitations
Expand Down
41 changes: 20 additions & 21 deletions roles/prepare/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!--
SPDX-License-Identifier: GPL-3.0-only
SPDX-FileCopyrightText: 2023 Red Hat, Project Atmosphere
SPDX-FileCopyrightText: 2023-2024 Red Hat, Project Atmosphere
Copyright 2023 Red Hat, Project Atmosphere
Copyright 2023-2024 Red Hat, Project Atmosphere
This program is free software: you can redistribute it and/or modify it under the terms of the GNU
General Public License as published by the Free Software Foundation, version 3 of the License.
Expand All @@ -25,51 +25,49 @@ If not, see <https://www.gnu.org/licenses/>.

Prepare RHEL managed host to run content from sap.sap_operations

Role ensures that all collection sap.sap_operations prerequisites are met.

Role ensures that all collection sap.sap_operations prerequisites are met.
Role works in two modes - normal and assert.

In normal mode it ensures that all prerequisites to run content from collection sap.sap_operations are met.

In assert mode it fails if collection prerequisites are not met on the host.

Role will only collect facts if OS distribution is not RedHat.

## Requirements

Role requires root access in order to install necessary packages and other sap.sap_operations collection prerequisites (normal mode).

## Role Variables

### Required parameters:

<!-- BEGIN: Role Input Parameters -->

## Role Variables
#### prepare_assert

Required parameters:

### prepare_assert
_Type:_ `bool`

- _Type:_ `bool`
- _Default:_ `False`
- _Required:_ `False`
_Default:_ `False`

_Required:_ `False`
_Description:_
If set to True role will only assert that all sap.sap_operations collection prerequisites are met.
Is set to False (default) will ensure that all sap.sap_operations collection prerequisites are met (root access required)

<!-- END: Role Input Parameters -->



## Requirements

Role requires root access in order to install necessary packages and other sap.sap_operations collection prerequisites (normal mode).

## Playbook examples

## Example Playbooks

```ansible
- hosts: all
roles:
- role: sap.sap_operations.prepare
```

'unpack_source' can be list of paths to folders and/or files.

Another options is to set 'unpack_source' value to file or folder.

```ansible
- hosts: all
vars:
Expand All @@ -78,6 +76,7 @@ Another options is to set 'unpack_source' value to file or folder.
- role: sap.sap_operations.prepare
```


## License

GPL-3.0-only
Expand Down
3 changes: 2 additions & 1 deletion roles/quality/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ A lot of checks are skipped and not executed on the host based on following rule
7. only checks for FencingAgent as high availability agent are executed
8. checks are executed if one of the following is true
a. check.role contains 'db' and respective database is detected by sap hostagent
b. check.role contains instance types that are detected by sap hostagent. Instance types (ASCS, ERS) are determined using processes detected by sap hostagent
b. check.role contains instance types that are detected by sap hostagent.
Instance types (ASCS, ERS) are determined using processes detected by sap hostagent

Limitations
Role tested only on single instance
Expand Down
4 changes: 4 additions & 0 deletions roles/sapcar/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,10 @@ _Required:_ `False`
_Description:_
Path to sapcar executable file
Default value is from collection variable sap_operations_sapcar_exe_path
All parent directories to directory where sapcar executable should be located should exists and be writable for ansible user
Role will not create /usr/sap directory and will not set owner and mode for this
Default path is in /usr/sap, role expects that /usr/sap is present and writable for user the role is executed with, otherwise role will fail
As part of the role execution parent directory for sapcar_exe_path will be created



Expand Down

0 comments on commit 8c06cf7

Please sign in to comment.