Skip to content

Commit

Permalink
Squashed commit of the following:
Browse files Browse the repository at this point in the history 
commit d256f79
Author: David Parker <[email protected]>
Date:   Sat Jan 18 13:42:33 2025 +0000

    [doc] Improve local install information

commit 9c33df9
Author: rene-oromtz <[email protected]>
Date:   Mon Jan 13 10:26:02 2025 -0600

    [patch] Add missing api_version to k8s_info lookup (#1616)

commit 0417879
Author: Harsh Tamakuwala <[email protected]>
Date:   Mon Jan 13 21:52:43 2025 +0530

    [patch] Adds some deletion waits in suite_app_uninstall (#1615)

    Co-authored-by: Harsh Tamakuwala <[email protected]>

commit 9a0893d
Author: David Parker <[email protected]>
Date:   Mon Jan 13 16:05:34 2025 +0000

    [patch] Run prettier on yaml files (#1621)

commit d500473
Author: Tremaine Hart <[email protected]>
Date:   Fri Jan 10 15:32:13 2025 -0600

    [patch] [MASCORE-5063] Problems with Restoring PV data - DT420492 (#1618)

commit 0fa5980
Author: Anil Prajapati <[email protected]>
Date:   Thu Jan 9 02:28:38 2025 +0530

    [minor] Support January Catalog Update (#1595)

    Co-authored-by: Parveen Kumar <[email protected]>

commit 5653ebd
Author: Harsh Tamakuwala <[email protected]>
Date:   Mon Jan 6 16:24:12 2025 +0530

    [patch] Fixes manage namespace uninstall stuck in terminating state (#1611)

    Co-authored-by: Harsh Tamakuwala <[email protected]>

commit 83d8365
Author: leo-miran <[email protected]>
Date:   Thu Dec 19 17:09:45 2024 -0300

    [patch] Remove OCP 4.12 & 4.13 from rotation (#1609)

commit 13770e9
Author: sekharcvalluri <[email protected]>
Date:   Thu Dec 19 19:19:48 2024 +0530

    [patch] Fix cos_bucket picking incorrect resourcegroup (#1593)

    Co-authored-by: Harsh Tamakuwala <[email protected]>
    Co-authored-by: leo-miran <[email protected]>

commit 0a3b97b
Author: David Parker <[email protected]>
Date:   Thu Dec 19 13:47:57 2024 +0000

    [major] Replace ICSP with IDMS (#1594)

commit b08cda4
Author: Harsh Tamakuwala <[email protected]>
Date:   Thu Dec 19 18:49:47 2024 +0530

    [patch] Update supported kafka versions (#1608)

    Co-authored-by: Harsh Tamakuwala <[email protected]>

commit cf05717
Author: David Parker <[email protected]>
Date:   Thu Dec 19 11:39:55 2024 +0000

    [patch] Lock mas-devops less than v2 (#1607)

commit 6ff397e
Author: David Parker <[email protected]>
Date:   Tue Dec 17 22:35:41 2024 +0000

    [patch] Enable HMAC by default for IBM COS (#1606)

commit 49b2099
Author: Rawa <[email protected]>
Date:   Thu Dec 12 16:28:49 2024 +0000

    [patch] Fix subscription lookup in upgrade (#1589)

    Co-authored-by: Rawa Resul <[email protected]>

commit 79c5991
Author: leo-miran <[email protected]>
Date:   Thu Dec 12 13:26:06 2024 -0300

    [patch] fix default booleans for suite_dns (#1590)

commit 1e91ba5
Author: Andrew Whitfield <[email protected]>
Date:   Thu Dec 12 07:34:31 2024 +0000

    [patch] Increase rosa deprovision wait time (#1592)

commit 91bd67b
Author: Ian Boden <[email protected]>
Date:   Mon Dec 9 10:32:54 2024 +0000

    [patch] reinstate zenmetastore and couchdb workarounds for cpd 4.8 (#1580)

commit aa05d8a
Author: Rawa <[email protected]>
Date:   Fri Dec 6 16:32:24 2024 +0000

    [patch] Fix label_selectors pattern (#1586)

    Co-authored-by: Rawa Resul <[email protected]>

commit e0ba0de
Author: Parveen Kumar <[email protected]>
Date:   Fri Dec 6 19:23:46 2024 +0530

    [minor] Support December catalog (#1562)

    Co-authored-by: Anil Prajapati <[email protected]>
    Co-authored-by: Jon Levell <[email protected]>
    Co-authored-by: Jon Levell <[email protected]>
    Co-authored-by: Ian Boden <[email protected]>
    Co-authored-by: Ian Boden <[email protected]>
    Co-authored-by: Anil Prajapati <[email protected]>
    Co-authored-by: Terence Quinn <[email protected]>
    Co-authored-by: David Parker <[email protected]>
    Co-authored-by: Rawa Resul <[email protected]>
    Co-authored-by: Rawa <[email protected]>

commit 9206656
Author: David Parker <[email protected]>
Date:   Tue Dec 3 14:36:31 2024 +0000

    [major] Use new OLM functions in mas-devops (#1573)

commit 3ccdbef
Author: Harsh Tamakuwala <[email protected]>
Date:   Mon Dec 2 18:30:04 2024 +0530

    [patch] Fixes ibmcloud_api_key issue in COS deprovision for ibmcloud (#1581)

    Co-authored-by: Harsh Tamakuwala <[email protected]>

commit 1283c03
Author: Terence Quinn <[email protected]>
Date:   Fri Nov 29 03:52:51 2024 -0600

    [patch] create unique certificate for each db2 instance (#1579)

commit e04138a
Author: David Parker <[email protected]>
Date:   Tue Nov 26 21:40:39 2024 +0000

    [patch] get_default_storage_classes should always set failed=False (#1578)

commit 7014f49
Author: Sanjay Prabhakar <[email protected]>
Date:   Tue Nov 26 16:32:42 2024 +0000

    [patch]  Add estimates for cpd in readme (#1577)

commit 9933bc2
Author: David Parker <[email protected]>
Date:   Tue Nov 26 13:46:05 2024 +0000

    [patch] Use correct variable for mongo extras (#1576)

commit bb720a3
Author: David Parker <[email protected]>
Date:   Tue Nov 26 13:32:30 2024 +0000

    [patch] Set cpd_product_version  from catalog metadata (#1575)

commit ba23e83
Author: Terence Quinn <[email protected]>
Date:   Mon Nov 25 15:03:03 2024 -0600

    [patch] Fix missing catalog_digest (#1574)

    Co-authored-by: David Parker <[email protected]>

commit 0f60c61
Author: Sanjay Prabhakar <[email protected]>
Date:   Fri Nov 22 17:33:20 2024 +0000

    [patch] Add back restore.yml.j2 (#1572)

    Co-authored-by: Sanjay Prabhakar <[email protected]>

commit 739c4d0
Author: David Parker <[email protected]>
Date:   Fri Nov 22 16:02:24 2024 +0000

    [major] Overhaul backup/restore capability (#1557)

    Co-authored-by: Sanjay Prabhakar <[email protected]>

commit d5ef410
Author: David Parker <[email protected]>
Date:   Fri Nov 22 12:39:48 2024 +0000

    [doc] Fix formatting

commit 61272c9
Author: Sanjay Prabhakar <[email protected]>
Date:   Fri Nov 22 12:27:00 2024 +0000

    [patch] fix restore for manage role (#1571)

    Co-authored-by: Sanjay Prabhakar <[email protected]>

commit 0a13abd
Author: Sanjay Prabhakar <[email protected]>
Date:   Thu Nov 21 10:40:05 2024 +0000

    [patch] Db2 backup/restore: fix copy local to pod script (#1569)

    Co-authored-by: Sanjay Prabhakar <[email protected]>

commit f474509
Author: David Parker <[email protected]>
Date:   Wed Nov 20 23:43:25 2024 +0000

    [major] Move catalog & storage class metadata to python package (#1561)

commit df4fe4c
Author: Lokesh <[email protected]>
Date:   Wed Nov 20 08:49:28 2024 -0500

    [patch] remove MIRRORLOGPATH folder creation  (#1568)

commit 5668f33
Author: Lokesh <[email protected]>
Date:   Wed Nov 20 07:49:43 2024 -0500

    [patch] fix conflicting DB config (#1567)

commit 5c595c1
Author: Sanjay Prabhakar <[email protected]>
Date:   Tue Nov 19 17:45:03 2024 +0000

    [patch] can skip db2 in br_manage playbook (#1566)

    Co-authored-by: Sanjay Prabhakar <[email protected]>

commit 8c8f993
Author: stonepd <[email protected]>
Date:   Tue Nov 19 16:39:18 2024 +0000

    [patch] update CP4D README, remove outdated fix code (#1565)

    Co-authored-by: Sanjay Prabhakar <[email protected]>

commit 5eb2cd4
Author: Sanjay Prabhakar <[email protected]>
Date:   Tue Nov 19 14:42:36 2024 +0000

    [patch] fix restore for core and fix tar command in restore tasks  (#1564)

    Co-authored-by: Sanjay Prabhakar <[email protected]>

commit e81d3a3
Author: dclain <[email protected]>
Date:   Sat Nov 16 15:39:54 2024 -0600

    [patch] Address several issues w/ Nvidia playbook (#1558)

commit 1792e98
Author: Tremaine Hart <[email protected]>
Date:   Thu Nov 14 13:19:26 2024 -0600

    [patch] Fixes and updates for IBMCloud COS support (#1555)

    Co-authored-by: David Parker <[email protected]>

commit 495e26d
Author: Daniel Istrate <[email protected]>
Date:   Thu Nov 14 13:02:17 2024 +0200

    [doc] Document storage class access mode (#1554)

    Co-authored-by: Daniel Istrate <[email protected]>

commit 08c22d7
Author: Anil Prajapati <[email protected]>
Date:   Tue Nov 12 02:51:17 2024 +0530

    [minor] Support November catalog (#1508)

    Co-authored-by: Parveen Kumar <[email protected]>
    Co-authored-by: Jon Levell <[email protected]>
    Co-authored-by: Jon Levell <[email protected]>
    Co-authored-by: Ian Boden <[email protected]>
    Co-authored-by: Ian Boden <[email protected]>

commit 3501786
Author: bmoferrall <[email protected]>
Date:   Thu Nov 7 09:53:24 2024 -0800

    [patch] MAXMIS-897: check if attribute 'deployimagestitching' is defined (#1551)

    Co-authored-by: Brendan More O'Ferrall <[email protected]>

commit 00c50f1
Author: caemar <[email protected]>
Date:   Thu Nov 7 11:47:38 2024 +0100

    [minor] Add Kafka Cluster CA certificate validityDays (#1543)

commit ee3a227
Author: bmoferrall <[email protected]>
Date:   Wed Nov 6 11:57:00 2024 -0800

    [patch] MAXMIS-886: disable stitching deploy when civil is not enabled2 (#1548)

    Co-authored-by: Brendan More O'Ferrall <[email protected]>

commit 3ee2512
Author: Tremaine Hart <[email protected]>
Date:   Wed Nov 6 11:41:34 2024 -0600

    [patch] [MASCORE-4344] Grafana role overwriting critical k8s configuration resource (#1549)

commit 482b386
Author: bmoferrall <[email protected]>
Date:   Tue Nov 5 21:51:50 2024 -0800

    [minor] #MAXMIS-748: add role to auto configure image stitching (#1530)

    Co-authored-by: Brendan More O'Ferrall <[email protected]>
    Co-authored-by: Alexandre Quinteiro <[email protected]>
    Co-authored-by: unnati-solanki-git <[email protected]>

commit dd13898
Author: Tremaine Hart <[email protected]>
Date:   Tue Nov 5 14:45:45 2024 -0600

    [patch] [MASCORE-4344] Grafana role overwriting critical k8s configuration resource (#1547)

commit ade2a0e
Author: Andrew Whitfield <[email protected]>
Date:   Tue Nov 5 17:18:24 2024 +0000

    [patch] wait for olm to update operatorcondition (#1545)

commit c267990
Author: Sanjay Prabhakar <[email protected]>
Date:   Tue Nov 5 16:33:07 2024 +0000

    [patch] prevent mongo upgrade when featureCompatibilityVersion is not defined or set incorrectly (#1544)

    Co-authored-by: Sanjay Prabhakar <[email protected]>

commit f4c04d5
Author: Ian Boden <[email protected]>
Date:   Tue Nov 5 11:21:08 2024 +0000

    [patch] Fix gpu-certified-operator default channel (#1542)

commit 733b595
Author: David Parker <[email protected]>
Date:   Mon Nov 4 15:49:12 2024 +0000

    [patch] Fix oc exec commands (#1541)

commit 224a9a8
Author: David Parker <[email protected]>
Date:   Thu Oct 31 18:10:39 2024 +0000

    [patch] Reduce useless logging (#1540)
  • Loading branch information
@karol-czarnecki
karol-czarnecki committed Jan 28, 2025
1 parent 5b740ce commit ffcae7d
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 32 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/ansible.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ on:
- '**'
jobs:
ansible-build:
name: Build Ansible Collection
runs-on: ubuntu-latest
if: ${{ !contains(github.event.head_commit.message, '[doc]') }}
steps:
- name: Install Python v3.11
uses: actions/setup-python@v5
Expand Down
43 changes: 11 additions & 32 deletions docs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,48 +36,27 @@ docker run -ti --rm --pull always quay.io/ibmmas/cli

Local Install
-------------------------------------------------------------------------------
### Install Python & Ansible
[Python 3.9](https://www.python.org/downloads/) is recommended as it is the most widely used version of Python within our development team, but any in-support 3.x version of Python should work fine.
Install the collection direct from [Ansible Galaxy](https://galaxy.ansible.com/ibm/mas_devops), you must also install the [mas-devops](https://pypi.org/project/mas-devops) Python package. [Python 3.11](https://www.python.org/downloads/) is recommended as it is the most widely used version of Python within our development team, but any in-support version of Python should work.

```bash
python3 --version
python3 -m pip install ansible junit_xml pymongo xmljson jmespath kubernetes==12.0.1 openshift==0.12.1
ansible --version
ansible-playbook --version
```
ansible-galaxy collection install ibm.mas_devops
python3 -m pip install mas-devops
```

We recommend using the latest version of ansible-core at all times (at time of writing this was v2.12.3) and the collection has a minimum supported version of ansible-core v2.10.3 which is enforced by the `ibm.mas_devops.ansible_version_check` role.

### Install OpenShift CLI
If you do not already have the `oc` command line tool, you can download it as below:
Optionally, you can also pin the version of the collection that you install, allowing you to control exactly what version of the collection is in use in your automation:

```
wget -q https://mirror.openshift.com/pub/openshift-v4/x86_64/clients/ocp/4.14.7/openshift-client-linux-4.14.7.tar.gz
tar -zxf openshift-client-linux.tar.gz
mv oc kubectl /usr/local/bin/
rm -rf openshift-client-linux.tar.gz
oc version
ansible-galaxy collection install ibm.mas_devops:18.10.4
python3 -m pip install mas-devops
```

### Install IBM Cloud CLI
If you are using this collection to manage an OpenShift cluster in IBM Cloud RedHat OpenShift Kubernetes Service (ROKS), then you must also install the IBM Cloud CLI:

```bash
curl -sL https://raw.githubusercontent.com/IBM-Cloud/ibm-cloud-developer-tools/master/linux-installer/idt-installer | bash
ibmcloud version`
```
The ansible collection makes use of many dependencies, you can find install scripts showing how we install these dependencies in our own container image in the [ibm-mas/cli-base](https://github.com/ibm-mas/cli-base/tree/stable/image/cli-base/install) repository, the dependencies you need will be determined by the roles that you intend to use, refer to the roles documentation for dependency infomation.

### Install the Ansible Collection
Install the collection direct from [Ansible Galaxy](https://galaxy.ansible.com/ibm/mas_devops)
!!! tip
Many systems contain more than one installation of Python, when you install the **mas-devops** package you must install it to the Python that Ansible is configured to use. You can check the version being used by Ansible by reviewing the output of `ansible --version`.

```
ansible-galaxy collection install ibm.mas_devops
```
If you see the error message `ERROR! Unexpected Exception, this is probably a bug: No module named 'mas'` it almost certainly means that you have not installed the mas-devops package, or have added it to the wrong instance of Python.

Optionally, you can also pin the version of the collection that you install, allowing you to control exactly what version of the collection is in use in your automation:
```
ansible-galaxy collection install ibm.mas_devops:18.10.4
```

Ansible Automation Platform
-------------------------------------------------------------------------------
Expand Down

0 comments on commit ffcae7d

Please sign in to comment.