CyVerse-Ansible.irods-env

Panoramica Versioni Approfondimenti

irods-env

Build Status Ansible Galaxy

DEPRECATED Please use CyVerse-Ansible.irods-cfg to create the irods_environment.json file for the server.

This tool generates an irods_environment.json file. It can create both the version needed for client tools like iCommands, iRODS FUSE, and the version for iRODS servers.

Initially designed for iRODS version 4.1.10, it should also work with any iRODS 4.1.x version.

Requirements

None required.

Role Variables

These are the variables you can use. None are mandatory.

Variable Default Choices Comments
irods_env_for_server false Specify if the file is for a server
irods_env_file ansible_env.HOME/.irods/irods_environment.json Path for the iRODS environment file to create
irods_env_sys_user_name ansible_env.USER System user using the iRODS environment file
irods_env_sys_group_name irods_env_sys_user_name Primary group of the system user using the file
irods_env_authentication_file Path to a file with authenticated iRODS user credentials
irods_env_authentication_scheme gsi, krb, native, pam User's authentication method
irods_env_client_server_negotiation none, request_server_negotiation Specify if advanced negotiation is desired
irods_env_client_server_policy CS_NEG_DONT_CARE, CS_NEG_REFUSE, CS_NEG_REQUIRE SSL policy to use
irods_env_control_plane_port Port for control plane operations
irods_env_control_plane_key Encryption key for grid control plane communication
irods_env_cwd Initial working collection
irods_env_debug Desired debug logging level
irods_env_default_hash_scheme MD5, SHA256 Checksum scheme
irods_env_default_resource Resource name for iRODS operations if not specified
irods_env_encryption_algorithm Encryption algorithm for parallel transfer and control
irods_env_encryption_key_size Key size for encryption
irods_env_encryption_num_hash_rounds Hash rounds for encryption
irods_env_encryption_salt_size Salt size for encryption
irods_env_gsi_server_dn Distinguished name of the GSI server
irods_env_home Home collection
irods_env_host inventory_hostname Fully qualified domain name for the iRODS server connection
irods_env_log_level Desired logging verbosity
irods_env_match_hash_policy compatible, strict Requirement for a specific hash scheme
irods_env_plugins_home Directory for client-side plugins
irods_env_port 1247 Port for the iRODS zone
irods_env_ssl_ca_certificate_file Trusted CA certificates in PEM format
irods_env_ssl_ca_certificate_path Directory containing CA certificates in PEM format
irods_env_ssl_certificate_chain_file File with the server's certificate chain
irods_env_ssl_certificate_key_file Private key for the server's certificate
irods_env_ssl_dh_params_file Location of Diffie-Hellman parameters file
irods_env_ssl_verify_server cert, hostname, none Level of server certificate authentication
irods_env_user_name anonymous iRODS user name for this account
irods_env_xmsg_host XMessage server host name
irods_env_xmsg_port XMessage server port
irods_env_zone_name tempZone Name of the iRODS zone

If irods_env_for_server is set to true, some variables will have different default values suitable for a server.

Variable Server Default
irods_env_cwd irods_env_home
irods_env_file /var/lib/irods/.irods/irods_environment.json
irods_env_sys_user_name irods
irods_env_client_server_negotiation request_server_negotiation
irods_env_client_server_policy CS_NEG_DONT_CARE
irods_env_control_plane_key TEMPORARY__32byte_ctrl_plane_key
irods_env_control_plane_port 1248
irods_env_default_hash_scheme SHA256
irods_env_default_resource demoResc
irods_env_encryption_algorithm AES-256-CBC
irods_env_encryption_key_size 32
irods_env_encryption_num_hash_rounds 16
irods_env_encryption_salt_size 8
irods_env_match_hash_policy compatible
irods_env_home /irods_env_zone_name/home/irods_env_user_name
irods_env_user_name rods

Dependencies

None.

Example Playbook

Here’s how to create an irods_environment.json for a client:

- hosts: clients
  roles:
    - role: irods-env
      irods_env_host: "{{ groups['ies'][0] }}"
      irods_env_user_name: tedgin
      irods_env_zone_name: iplant

Here’s how to create an irods_environment.json for an iRODS server:

- hosts: rs
  roles:
    - role: irods-env
      irods_env_for_server: true
      irods_env_user_name: "{{ irods_adm_name }}"
      irods_env_zone_name: iplant
      irods_env_control_plane_key: "{{ irods_control_plane_key }}"
      irods_env_default_hash_scheme: MD5
      irods_env_default_resource: "{{ irods_default_resource }}"

License

See license.

Author Information

Tony Edgin
tedgin@cyverse.org
CyVerse

Informazioni sul progetto

A role for generating iRODS environment files. This role is deprecated. Please use CyVerse-Ansible.irods-cfg (https://galaxy.ansible.com/CyVerse-Ansible/irods-cfg).

role CyVerse environment iRODS
Installa
ansible-galaxy install CyVerse-Ansible.irods-env
GitHub repository
0 stelle
0 fork
0 problemi aperti
Licenza
other
Download
163
Proprietario