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

[patch] Reduce useless logging #1540

Merged
merged 3 commits into from
Oct 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
- name: Install and Build
run: |
bash build/bin/copy-role-docs.sh
python -m pip install -q mkdocs
python -m pip install -q mkdocs mkdocs-carbon mkdocs-glightbox
mkdocs build --verbose --clean --strict

- name: Deploy
Expand Down
16 changes: 8 additions & 8 deletions docs/execution-environment.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Execution Environment
===============================================================================
Details on the Red Hat Ansible Automation Platform Execution Environment for ansible-devops.
Details on the [Red Hat Ansible Automation Platform](https://www.redhat.com/en/technologies/management/ansible) Execution Environment for the **ibm.mas_devops** Ansible Collection.


Execution Environment Image
Expand Down Expand Up @@ -228,7 +228,7 @@ If you need to set an environment variable then you can do this in the playbook
ocp_version: 4.14.35
rosa_compute_nodes: 3

environment:
environment:
AWS_DEFAULT_REGION: us-east-1
AWS_ACCESS_KEY_ID: "{{ aws_access_key_id }}"
AWS_SECRET_ACCESS_KEY: "{{ aws_secret_access_key }}"
Expand Down Expand Up @@ -296,12 +296,12 @@ This playbook requires the following survey questions to be setup:

pre_tasks:
- name: "Asserts aws_access_key_id secret defined"
assert:
assert:
that: aws_access_key_id is defined
fail_msg: "aws_access_key_id not defined"

- name: "Asserts aws_secret_access_key secret defined"
assert:
assert:
that: aws_secret_access_key is defined
fail_msg: "aws_secret_access_key not defined"

Expand Down Expand Up @@ -332,7 +332,7 @@ This playbook requires the following survey questions to be setup:
# -------------------------------------------------------------------------
- name: "Create k8s Job to run {{ masbr_action }} tasks"
when: masbr_create_task_job
include_tasks:
include_tasks:
file: "{{ role_path }}/../../common_tasks/backup_restore/create_run_tasks_job.yml"
vars:
_rt_playbook_name: "br_core"
Expand All @@ -347,7 +347,7 @@ This playbook requires the following survey questions to be setup:
masbr_storage_cloud_rclone_file: rclone.conf
masbr_storage_cloud_rclone_name: masbr
masbr_storage_cloud_bucket: mas-backup

# Run backup/restore tasks locally
# -------------------------------------------------------------------------
- name: "Run {{ masbr_action }} tasks"
Expand Down Expand Up @@ -460,7 +460,7 @@ Example setting role vars:
kafka_version: 3.7.0
```

One caveat to the above is the `backup/restore` tasks as these use a combination of ansible vars and expecting environment variables to be set in the `ansible_env` variable. In order to work with `the backup/restore` tasks you need to set both `environment` and role/task vars (not play vars).
One caveat to the above is the `backup/restore` tasks as these use a combination of ansible vars and expecting environment variables to be set in the `ansible_env` variable. In order to work with `the backup/restore` tasks you need to set both `environment` and role/task vars (not play vars).

Example, showing `environment` and task vars set. See [backup exmaple](#examples-of-playbooks) for more complete play:
```yaml
Expand Down
48 changes: 0 additions & 48 deletions docs/extra.css

This file was deleted.

27 changes: 5 additions & 22 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,18 @@
MAS Devops Ansible Collection
MAS DevOps Ansible Collection
===============================================================================

MAS Compatability
-------------------------------------------------------------------------------
The collection supports IBM Maximo Application Suite version 8.10 and above.


Releases
-------------------------------------------------------------------------------
[https://github.com/ibm-mas/ansible-devops/releases](https://github.com/ibm-mas/ansible-devops/releases)
The **ibm.mas_devops** Ansible Collection is published on [Ansible Galaxy](https://galaxy.ansible.com/ui/repo/published/ibm/mas_devops/) and works with all supported releases of IBM Maximo Application Suite. Release information for the collection can be found in [GitHub](https://github.com/ibm-mas/ansible-devops/releases).


Usage
-------------------------------------------------------------------------------
### Run a playbook
### Run a Playbook
The collection includes a number of playbooks that string together multiple roles, you can directly invoke them after installing the collection:

```bash
ansible-playbook ibm.mas_devops.lite_core_roks
```

### Run a role
### Run a Role
If you only want to perform a single action, you can directly invoke one of our roles from the command line without the need to build a playbook:

```bash
Expand Down Expand Up @@ -75,7 +67,6 @@ curl -sL https://raw.githubusercontent.com/IBM-Cloud/ibm-cloud-developer-tools/m
ibmcloud version`
```


### Install the Ansible Collection
Install the collection direct from [Ansible Galaxy](https://galaxy.ansible.com/ibm/mas_devops)

Expand All @@ -90,19 +81,11 @@ ansible-galaxy collection install ibm.mas_devops:18.10.4

Ansible Automation Platform
-------------------------------------------------------------------------------
If you wish to use Ansible Automation Platform then a Automation Execution Environment image is available at [quay.io/ibmmas/ansible-devops-ee](https://quay.io/repository/ibmmas/ansible-devops-ee?tab=tags&tag=latest) that contains the `ibm.mas_devops` collection at the same release level, plus required client packages and access to the automation content collections supported by Red Hat.
If you wish to use [Red Hat Ansible Automation Platform](https://www.redhat.com/en/technologies/management/ansible) then a Automation Execution Environment image is available at [quay.io/ibmmas/ansible-devops-ee](https://quay.io/repository/ibmmas/ansible-devops-ee?tab=tags&tag=latest) that contains the `ibm.mas_devops` collection at the same release level, plus required client packages and access to the automation content collections supported by Red Hat.

More details on how to use the ansible-devops execution environment can be found [here](execution-environment.md)


Support
-------------------------------------------------------------------------------
This Ansible collection is developed by the IBM Maximo Application Suite development team, customers may raise support tickets via the same routes they would an issue with the product itself, or [raise an issue directly in the GitHub repository](https://github.com/ibm-mas/ansible-devops/issues).


<!--
## Install via Automation Operator
You can now install the Maximo Application Suite via a single operator. The operator will run all the MAS ansible in the background for you. This is a good approach if you do not have extensive MAS experience or do not want to install via other methods. The operator provides defaults for a straightforward installation.

To leverage this approach, install the custom catalog into your cluster and simply install and use the operator as any other operator. More detailed instructions and installation notes can be found [here](https://github.com/cloud-native-toolkit/operator-masauto)
-->
1 change: 1 addition & 0 deletions ibm/mas_devops/common_tasks/get_version_from_channel.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
name: "{{ op_pm_name }}"
namespace: openshift-marketplace
register: op_pm_lookup
no_log: true # This generates a huge amount of (useless) logging

- name: Assert that PackageManifest exists
ansible.builtin.assert:
Expand Down
1 change: 1 addition & 0 deletions ibm/mas_devops/common_tasks/wait_for_crd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,4 @@
until:
- _crd_info.resources is defined
- _crd_info.resources | length > 0
no_log: true # This generates a huge amount of (useless) logging
61 changes: 35 additions & 26 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
# mkdocs serve

site_name: MAS Devops Collection
site_name: MAS DevOps Ansible Collection
site_url: https://ibm-mas.github.io/ansible-devops

repo_name: GitHub
repo_url: https://github.com/ibm-mas/ansible-devops
edit_uri: blob/master/docs/

nav:
- "Home": index.md
- "Execution Environment": execution-environment.md
- "General Information":
- "Home": index.md
- "Ansible Automation Platform": execution-environment.md
- "Playbooks":
- "OCP": playbooks/ocp.md
- 'Install Cloud Pak For Data': playbooks/cp4d.md
Expand Down Expand Up @@ -109,29 +110,37 @@ nav:
- "gencfg_mongo": roles/gencfg_mongo.md

theme:
name: readthedocs
highlightjs: true
hljs_languages:
- yaml
prev_next_buttons_location: none
extra_css:
- extra.css
name: carbon
prefix: IBM
header_nav_items:
- title: Ansible
active: true
- title: CLI
url: https://ibm-mas.github.io/cli/

markdown_extensions:
- toc:
permalink:
permalink: "¤"
- admonition
# Add this to support expandable sections
#- pymdownx.details
# https://squidfunk.github.io/mkdocs-material/extensions/admonition/
# Note
# Abstract
# Info
# Tip
# Success
# Question
# Warning
# Failure
# Danger
# Bug
# Example
# Quote
# https://squidfunk.github.io/mkdocs-material/extensions/admonition/
# Note
# Abstract
# Info
# Tip
# Success
# Question
# Warning
# Failure
# Danger
# Bug
# Example
# Quote

plugins:
- search: {}
- glightbox:
shadow: true
caption_position: bottom
auto_caption: true
touchNavigation: false
background: black
Loading