[ansible] JFrog Platform 7.18.6

2026-01-20 22:06:55 -06:00 · 2021-05-10 13:21:22 +05:30
parent 224ece535d
commit 4c40d2c400
126 changed files with 0 additions and 0 deletions
--- a/Ansible/ansible_collections/jfrog/platform/README.md
+++ b/Ansible/ansible_collections/jfrog/platform/README.md
@@ -0,0 +1,111 @@
+# JFrog Platform Ansible Collection
+
+This Ansible directory consists of the following directories that support the JFrog Platform collection.
+ 
+ * [ansible_collections directory](ansible_collections) - This directory contains the Ansible collection package that has the Ansible roles for Artifactory, Distribution, Missioncontrol and Xray. See the roles README for details on the product roles and variables.
+ * [examples directory](examples) - This directory contains example playbooks for various architectures.
+ 
+
+ ## Getting Started
+ 
+ 1. Install this collection from Ansible Galaxy.
+    
+    ```
+    ansible-galaxy collection install jfrog.platform
+    ```
+        
+    Ensure you reference the collection in your playbook when using these roles.
+        
+    ```
+    ---
+    - hosts: artifactory_servers
+      collections:
+        - jfrog.platform
+      roles:
+        - artifactory
+    
+    ```
+    
+ 2. Ansible uses SSH to connect to hosts. Ensure that your SSH private key is on your client and the public keys are installed on your Ansible hosts. 
+ 
+ 3. Create your inventory file. Use one of the examples from the [examples directory](examples) to construct an inventory file (hosts.ini) with the host addresses
+ 
+ 4. Create your playbook. Use one of the examples from the [examples directory](examples) to construct a playbook using the JFrog Ansible roles. These roles will be applied to your inventory and provision software.
+ 
+ 5. Then execute with the following command to provision the JFrog Platform with Ansible.
+ 
+```
+ansible-playbook -vv platform.yml -i hosts.ini"
+```
+
+## Generating Master and Join Keys
+**Note** : If you don't provide these keys, they will be set to defaults (check groupvars/all/vars.yaml file)
+For production deployments,You may want to generate your master amd join keys and apply it to all the nodes.
+**IMPORTANT** : Save below generated master and join keys for future upgrades
+
+```
+MASTER_KEY_VALUE=$(openssl rand -hex 32)
+JOIN_KEY_VALUE=$(openssl rand -hex 32)
+ansible-playbook -vv platform.yml -i hosts.ini --extra-vars "master_key=$MASTER_KEY_VALUE join_key=$JOIN_KEY_VALUE"
+```
+
+## Using [Ansible Vault](https://docs.ansible.com/ansible/latest/user_guide/vault.html) to Encrypt Vars
+Some vars you may want to keep secret. You may put these vars into a separate file and encrypt them using [Ansible Vault](https://docs.ansible.com/ansible/latest/user_guide/vault.html).
+
+```
+ansible-vault encrypt secret-vars.yml --vault-password-file ~/.vault_pass.txt
+```
+
+then in your playbook include the secret vars file.
+
+```
+- hosts: artifactory_servers
+
+  vars_files:
+    - ./vars/secret-vars.yml
+    - ./vars/vars.yml
+
+  roles:
+    - artifactory
+```
+
+## Upgrades
+All JFrog product roles support software updates. To use a role to perform a software update only, use the _<product>_upgrade_only_ variable and specify the version. See the following example.
+
+```
+- hosts: artifactory_servers
+  vars:
+    artifactory_version: "{{ lookup('env', 'artifactory_version_upgrade') }}"
+    artifactory_upgrade_only: true
+  roles:
+    - artifactory
+
+- hosts: xray_servers
+  vars:
+    xray_version: "{{ lookup('env', 'xray_version_upgrade') }}"
+    xray_upgrade_only: true
+  roles:
+    - xray
+```
+
+## Building the Collection Archive
+1. Go to the [ansible_collections/jfrog/platform directory](ansible_collections/jfrog/platform).
+2. Update the galaxy.yml meta file as needed. Update the version.
+3. Build the archive. (Requires Ansible 2.9+)
+```
+ansible-galaxy collection build
+```
+
+## OS support 
+The JFrog Platform Ansible Collection can be installed on the following operating systems:
+
+* Ubuntu LTS versions (16.04/18.04/20.4)
+* Centos/RHEL 7.x/8.x
+* Debian 9.x/10.x
+
+## Known issues
+* Refer [here](https://github.com/jfrog/JFrog-Cloud-Installers/issues?q=is%3Aopen+is%3Aissue+label%3AAnsible)
+* By default, ansible_python_interpreter: "/usr/bin/python3" used , For Centos/RHEL-7, Set this to "/usr/bin/python" . For example
+```
+ansible-playbook -vv platform.yml -i hosts.ini -e 'ansible_python_interpreter=/usr/bin/python'
+```