├── .gitignore ├── files ├── simple_specfile.json ├── full_specfile.json └── requirements_example.yml ├── examples ├── assemble_node.yaml ├── delete_node.yaml ├── forced_off.yaml ├── reboot.yaml ├── allocate_specfile.yaml ├── assemble_specfile.yaml ├── change_boot_options.yaml ├── allocate_spec.yaml └── assemble_spec.yaml ├── defaults └── main │ ├── podm.yml │ ├── output.yml │ └── composition.yml ├── meta └── main.yml ├── tasks ├── main.yml └── multinode_composition.yml ├── library ├── doc_fragments │ └── rsd.py ├── rsd_power.py ├── rsd_boot.py ├── rsd_compose.py └── LICENSE ├── README.md ├── module_utils ├── rsd_common.py └── LICENSE └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | *.retry 2 | *.pyc 3 | /.pydevproject 4 | /.project 5 | /.settings/ 6 | -------------------------------------------------------------------------------- /files/simple_specfile.json: -------------------------------------------------------------------------------- 1 | { 2 | "Name": "Test node", 3 | "Description": "Node for testing allocate_specfile.yaml", 4 | "TotalSystemMemoryMiB": 8000, 5 | "TotalSystemCoreCount": 8 6 | } 7 | -------------------------------------------------------------------------------- /examples/assemble_node.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: localhost 3 | connection: local 4 | gather_facts: no 5 | tasks: 6 | - name: Assemble an already allocated node 7 | rsd_compose: 8 | id: 9 | value: 25 10 | state: assembled 11 | -------------------------------------------------------------------------------- /examples/delete_node.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: localhost 3 | connection: local 4 | gather_facts: no 5 | tasks: 6 | - name: Remove the composed node identified by id 7 | rsd_compose: 8 | id: 9 | value: 27 10 | state: absent 11 | -------------------------------------------------------------------------------- /examples/forced_off.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: localhost 3 | connection: local 4 | gather_facts: no 5 | tasks: 6 | - name: Trigger node reboot 7 | rsd_power: 8 | id: 9 | value: 1 10 | type: identity 11 | state: off 12 | force: true 13 | -------------------------------------------------------------------------------- /examples/reboot.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: localhost 3 | connection: local 4 | gather_facts: no 5 | tasks: 6 | - name: Trigger node reboot 7 | rsd_power: 8 | id: 9 | value: 1 10 | type: identity 11 | state: restarted 12 | force: false 13 | -------------------------------------------------------------------------------- /examples/allocate_specfile.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: localhost 3 | connection: local 4 | gather_facts: no 5 | tasks: 6 | - name: Allocate a node from a PODM compliant JSON info/requirements file 7 | rsd_compose: 8 | specfile: specfile.json 9 | state: allocated 10 | -------------------------------------------------------------------------------- /examples/assemble_specfile.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: localhost 3 | connection: local 4 | gather_facts: no 5 | tasks: 6 | - name: Assemble a node from a PODM compliant JSON info/requirements file 7 | rsd_compose: 8 | specfile: specfile/simple.json 9 | state: assembled 10 | -------------------------------------------------------------------------------- /examples/change_boot_options.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: localhost 3 | connection: local 4 | gather_facts: no 5 | tasks: 6 | - name: Override Boot options to boot once from PXE boot in UEFI mode. 7 | rsd_boot: 8 | id: 9 | value: 1 10 | boot_target: pxe 11 | boot_enable: once 12 | boot_mode: uefi 13 | -------------------------------------------------------------------------------- /examples/allocate_spec.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: localhost 3 | connection: local 4 | gather_facts: no 5 | tasks: 6 | - name: Allocate a node from the specified info/requirements 7 | rsd_compose: 8 | spec: 9 | name: Test node 10 | description: Node for testing allocate_spec.yaml 11 | total_cores: 8 12 | state: allocated 13 | -------------------------------------------------------------------------------- /examples/assemble_spec.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: localhost 3 | connection: local 4 | gather_facts: no 5 | tasks: 6 | - name: Assemble a node from the specified info/requirements 7 | rsd_compose: 8 | spec: 9 | name: Test node 10 | description: Node for testing assemble assemble_spec.yaml 11 | total_mem: 8000 12 | state: assembled 13 | -------------------------------------------------------------------------------- /defaults/main/podm.yml: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2019 Intel Corporation. All rights reserved. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # 7 | # http://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | 15 | --- 16 | # Determine whether to validate PODM'S certificate when using HTTPS. 17 | podm_validate_cert: False 18 | -------------------------------------------------------------------------------- /meta/main.yml: -------------------------------------------------------------------------------- 1 | galaxy_info: 2 | author: Marco Chiappero, Radoslaw Kuschel 3 | description: Provision multiple nodes at once from Intel Rack Scale Design 4 | composable hardware 5 | company: Intel Corporation 6 | license: "(Apache v2.0, GPLv3+)" 7 | min_ansible_version: 2.6.2 8 | 9 | platforms: 10 | - name: Debian 11 | versions: 12 | - all 13 | - name: Ubuntu 14 | versions: 15 | - all 16 | - name: EL 17 | versions: 18 | - all 19 | - name: Fedora 20 | versions: 21 | - all 22 | - name: opensuse 23 | versions: 24 | - all 25 | 26 | galaxy_tags: 27 | - rackscale 28 | - rsd 29 | - system 30 | - orchestration 31 | - system 32 | - composability 33 | - provisioning 34 | 35 | dependencies: [] 36 | -------------------------------------------------------------------------------- /tasks/main.yml: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2019 Intel Corporation. All rights reserved. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # 7 | # http://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | 15 | --- 16 | - name: Store current timestamp 17 | set_fact: 18 | date_time: "{{ ansible_date_time }}" 19 | when: rsd_write_to_files 20 | 21 | - include_tasks: multinode_composition.yml 22 | with_sequence: start=1 end={{ number_of_nodes_to_provision }} format={{ rsd_node_name }}_%02d 23 | -------------------------------------------------------------------------------- /defaults/main/output.yml: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2019 Intel Corporation. All rights reserved. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # 7 | # http://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | 15 | --- 16 | # Base directory for storing output files, by default in the same location as 17 | # the playbook 18 | rsd_output_path: "{{ playbook_dir }}" 19 | 20 | # Group name used in the inventory file to group IPs of the composed 21 | # nodes 22 | rsd_inventory_group: rsd_nodes 23 | 24 | # Control variable to enable output and inventory file creation 25 | # (node details are still be available as a fact under "rsd_node_info") 26 | rsd_write_to_files: False 27 | -------------------------------------------------------------------------------- /files/full_specfile.json: -------------------------------------------------------------------------------- 1 | { 2 | "Name": "My first composed node", 3 | "Description": "Test node", 4 | "Processors": [{ 5 | "Model": "Multi-Core Intel(R) Xeon(R) processor 7xxx Series", 6 | "TotalCores": 2, 7 | "AchievableSpeedMHz": 2000, 8 | "InstructionSet": "x86" 9 | }], 10 | "Memory": [{ 11 | "CapacityMiB": 16000, 12 | "MemoryDeviceType": "DDR3", 13 | "SpeedMHz": 1600, 14 | "Manufacturer": "Intel", 15 | "DataWidthBits": 64 16 | }], 17 | "RemoteDrives": [{ 18 | "@odata.type" : "AllocationComposedNodeRequest.v1_1_0.RemoteDrive", 19 | "CapacityGiB": 80, 20 | "Protocol": "iSCSI", 21 | "Master": { 22 | "Type": "Snapshot" 23 | } 24 | }], 25 | "LocalDrives": [{ 26 | "CapacityGiB": 500, 27 | "Type": "HDD", 28 | "MinRPM": 5400, 29 | "SerialNumber": "12345678", 30 | "Interface": "SATA", 31 | "FabricSwitch": false 32 | }], 33 | "EthernetInterfaces": [{ 34 | "SpeedMbps": 1000, 35 | "PrimaryVLAN": 100, 36 | "VLANs": [{ 37 | "VLANId": 100, 38 | "Tagged": false 39 | }] 40 | }], 41 | "Security": { 42 | "TpmPresent": true, 43 | "TpmInterfaceType": "TPM2_0", 44 | "TxtEnabled": false, 45 | "ClearTPMOnDelete": true, 46 | "PersistentMemoryOperationOnDelete": "OverwritePCD" 47 | }, 48 | "Oem": { 49 | }, 50 | "TotalSystemMemoryMiB": 32000, 51 | "TotalSystemCoreCount": 2, 52 | "SupportedPerformanceConfigurations": ["StaticSpeedSelect"] 53 | } -------------------------------------------------------------------------------- /defaults/main/composition.yml: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2019 Intel Corporation. All rights reserved. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # 7 | # http://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | 15 | --- 16 | # Number of nodes to be created by the role 17 | number_of_nodes_to_provision: 10 18 | 19 | # Default node name 20 | rsd_node_name: node 21 | 22 | # A short text description associated to node 23 | rsd_node_description: "Composed Node" 24 | 25 | # Minimum total CPU cores of the system 26 | rsd_node_cores: 0 27 | 28 | # Minimum total memory of the system 29 | rsd_node_memory: 0 30 | 31 | # List of processor requirements 32 | rsd_node_processors: [] 33 | 34 | # List of memory specification 35 | rsd_node_memory_spec: [] 36 | 37 | # List of local drives to be allocated 38 | rsd_node_local_drives: [] 39 | 40 | # List of remote drives to be attached 41 | rsd_node_remote_drives: [] 42 | 43 | # List of interfaces and their requirements 44 | rsd_node_eth_interfaces: [] 45 | 46 | # No security options by default 47 | #security: { } 48 | 49 | # State of the composed node: allocated, assembled. default: assembled 50 | rsd_node_state: assembled 51 | 52 | # State node boot options. Boot_target and boot_enable are mandatory, 53 | # boot_mode is optional. 54 | rsd_boot_option: 55 | boot_target: 56 | boot_enable: 57 | boot_mode: 58 | -------------------------------------------------------------------------------- /library/doc_fragments/rsd.py: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2019 Intel Corporation. All rights reserved. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # 7 | # http://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | # 15 | # Authors: 16 | # - Marco Chiappero 17 | ####################################################### 18 | 19 | class ModuleDocFragment(object): 20 | 21 | DOCUMENTATION = ''' 22 | options: 23 | podm: 24 | description: 25 | - A dictionary containing information for connecting to a remote PODM. 26 | - A the very least a host has to be provided, but other parameters may 27 | be optional and/or specified through environment variables. 28 | required: false 29 | suboptions: 30 | host: 31 | description: 32 | - A hostname or IP adress for connecting to PODM. 33 | - Alternatively, if not specified, the environment variable 34 | C(PODM_HOST) can be used. 35 | required: true 36 | port: 37 | description: 38 | - Port for the PODM API service. 39 | - The environment variable C(PODM_PORT) can be defined 40 | instead. 41 | default: 8443 42 | type: int 43 | protocol: 44 | description: 45 | - Specifies the protocol to be used to connect to PODM 46 | default: https 47 | choices: 48 | - http 49 | - https 50 | validate_certs: 51 | description: 52 | - Whether or not SSL API requests should be verified. 53 | default: false 54 | type: bool 55 | 56 | auth: 57 | description: 58 | - A dictionary containing PODM access credentials 59 | suboptions: 60 | username: 61 | description: 62 | - The username required to interact with PODM API 63 | - Especially for security reasons, the environment variable 64 | C(PODM_USERNAME) can be provided instead. 65 | required: true 66 | aliases: 67 | - user 68 | password: 69 | description: 70 | - The password required to interact with PODM API 71 | - Especially for security reasons, the environment variable 72 | C(PODM_PASSWORD) can be provided instead. 73 | required: true 74 | aliases: 75 | - pass 76 | 77 | requirements: 78 | - rsd-lib > 1.0.0 79 | - RSD PODM API >= 2.1 80 | 81 | seealso: 82 | - name: Rack Scale Design documentation 83 | description: Reference RSD documentation, including the latest PODM API 84 | specification containing detailed information on the 85 | supported values and options for composition. 86 | link: https://www.intel.com/content/www/us/en/architecture-and-technology/rack-scale-design/rack-scale-design-resources.html 87 | ''' 88 | -------------------------------------------------------------------------------- /files/requirements_example.yml: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2019 Intel Corporation. All rights reserved. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # 7 | # http://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | 15 | --- 16 | # Below is a complete example of "enumerated" node composition. Based on the 17 | # variables set below it will create 5 nodes with: 18 | # - at least 1 CPU with 20 cores clocked 3000Mhz, but at least 30 cores in the 19 | # overall system, and one remote FPGA; 20 | # - 20GB of memory of type DDR4 and speed 2400Mhz but 40GB of overall system 21 | # memory 22 | # - 1 local NVMe drive of at least 100GB and 2 remote NVMe drives sized at 23 | # least 80GB and 20GB 24 | # - 1 ethernet interface capable of 10G 25 | 26 | 27 | # This variable defines the number of nodes to be created by the role 28 | # During the role execution an index up to this number will be used to 29 | # generate a unique name for each node. For example: assuming a value of 3 and 30 | # a node name set to 'test', the role will generate unique names as follow: 31 | # test_01, test_02, test_03. 32 | number_of_nodes_to_provision: 5 33 | 34 | 35 | # Following are either specific requirements (types, protocols, etc) or 36 | # quantities to define the specification of the nodes to be composed. For 37 | # each quantity PODM will match or exceed them or fail. Constraints for 38 | # processors, memory slots, drives and interfaces can be repeated up to the 39 | # desired amount (that is, they represent a list of entities containing 40 | # key-value specified requirements). 41 | # To avoid providing one requirement, simply comment out the related variable. 42 | 43 | # Name assigned to the composed node. 44 | rsd_node_name: compute 45 | 46 | # A short text description associated to node e.g. "OpenStack Compute Node". 47 | rsd_node_description: "OpenStack Compute Node" 48 | 49 | # The composed node will have at lest the amount CPU cores here specified, 50 | # potentially accross multiple CPUs. 51 | rsd_node_cores: 30 52 | 53 | # Minimum amount of memory for the whole system, in MiB unit. 54 | rsd_node_memory: 40000 55 | 56 | # FPGA over fabric request and attachment, plus specific specs for a single 57 | # CPU. 58 | rsd_node_processors: 59 | - { ProcessorType: FPGA, Connectivity: RemotePCIe } 60 | - { ProcessorType: CPU, AchievableSpeedMHz: 3000, TotalCores: 20 } 61 | 62 | # Memory requirements, for requesting specific memory technologies, speeds, 63 | # etc. 64 | rsd_node_memory_spec: 65 | - { CapacityMiB: 20000, MemoryDeviceType: DDR4, SpeedMHz: 2400 } 66 | 67 | # List of local drives to assigned to the node and their specifications, such 68 | # as capacity, type and interface. 69 | rsd_node_local_drives: 70 | - { CapacityGiB: 100, Type: SSD, Interface: NVMe } 71 | 72 | # List of remote drives to be attached to the node with their size and other 73 | # desired characteristics. 74 | rsd_node_remote_drives: 75 | - { CapacityGiB: 80, Protocol: NVMeOverFabrics } 76 | - { CapacityGiB: 20, Protocol: NVMeOverFabrics } 77 | 78 | # List of interfaces and their desired specifications, such as their desired 79 | # link speed. 80 | rsd_node_eth_interfaces: 81 | - { SpeedMbps: 10000 } 82 | 83 | # In case it's preferred to have control over the proposed node specification 84 | # before actually instantiating the node, just use 'allocated' for review and 85 | # subsequent deletion ('absent') or assembly ('assembled'). 86 | rsd_node_state: assembled 87 | 88 | # This function set node booting options. Boot_target and boot_enable are 89 | # mandatory arguments to perform overwrite boot option action, boot_mode 90 | # is optional. 91 | rsd_boot_option: 92 | boot_target: hdd 93 | boot_enable: once 94 | boot_mode: legacy 95 | -------------------------------------------------------------------------------- /tasks/multinode_composition.yml: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2019 Intel Corporation. All rights reserved. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # 7 | # http://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | 15 | --- 16 | - name: Compose Node 17 | rsd_compose: 18 | spec: 19 | name: "{{ item }}" 20 | description: "{{ rsd_node_description }}" 21 | processors: "{{ rsd_node_processors }}" 22 | local_drives: "{{ rsd_node_local_drives }}" 23 | remote_drives: "{{ rsd_node_remote_drives }}" 24 | eth_ifaces: "{{ rsd_node_eth_interfaces }}" 25 | memory: "{{ rsd_node_memory_spec }}" 26 | total_mem: "{{ rsd_node_memory }}" 27 | total_cores: "{{ rsd_node_cores }}" 28 | state: "{{ rsd_node_state }}" 29 | podm: 30 | validate_cert: "{{ podm_validate_cert }}" 31 | register: output 32 | 33 | - name: Overwrite boot options three arguments 34 | rsd_boot: 35 | id: 36 | value: "{{ output.node.Id }}" 37 | boot_target: "{{ rsd_boot_option.boot_target }}" 38 | boot_enable: "{{ rsd_boot_option.boot_enable }}" 39 | boot_mode: "{{ rsd_boot_option.boot_mode }}" 40 | podm: 41 | validate_cert: "{{ podm_validate_cert }}" 42 | when: | 43 | rsd_boot_option.boot_mode is defined and 44 | rsd_boot_option.boot_target is defined and 45 | rsd_boot_option.boot_enable is defined and 46 | rsd_boot_option.boot_mode is not none and 47 | rsd_boot_option.boot_target is not none and 48 | rsd_boot_option.boot_target is not none 49 | 50 | - name: Overwrite boot options two arguments 51 | rsd_boot: 52 | id: 53 | value: "{{ output.node.Id }}" 54 | boot_target: "{{ rsd_boot_option.boot_target }}" 55 | boot_enable: "{{ rsd_boot_option.boot_enable }}" 56 | podm: 57 | validate_cert: "{{ podm_validate_cert }}" 58 | when: | 59 | rsd_boot_option.boot_enable is defined and 60 | rsd_boot_option.boot_target is defined and 61 | rsd_boot_option.boot_enable is not none and 62 | rsd_boot_option.boot_target is not none and 63 | (rsd_boot_option.boot_mode is not defined or rsd_boot_option.boot_mode is none) 64 | 65 | - name: Restart Node 66 | rsd_power: 67 | id: 68 | value: "{{ output.node.Id }}" 69 | state: restarted 70 | podm: 71 | validate_cert: "{{ podm_validate_cert }}" 72 | 73 | - name: Collect node details 74 | set_fact: 75 | rsd_node_info: "{{ rsd_node_info | default([]) | combine({ output.node.Name: output.node }) }}" 76 | 77 | - name: Create output files 78 | block: 79 | 80 | - name: Generate name for node information file 81 | set_fact: 82 | rsd_node_info_filename: "{{ rsd_output_path }}/{{ rsd_inventory_group }}-{{ date_time.date }}-{{ date_time.time }}.json" 83 | 84 | - name: Create node information file 85 | file: 86 | path: "{{ rsd_node_info_filename }}" 87 | state: touch 88 | mode: 0600 89 | 90 | - name: Append node details to file 91 | copy: 92 | content: "{{ rsd_node_info | to_nice_json }}" 93 | dest: "{{ rsd_node_info_filename }}" 94 | 95 | - name: Create inventory file 96 | file: 97 | path: "{{ rsd_output_path }}/inventory" 98 | state: touch 99 | mode: 0600 100 | 101 | - name: Create inventory key for "{{ rsd_inventory_group }}" group 102 | lineinfile: 103 | dest: "{{ rsd_output_path }}/inventory" 104 | line: "[{{ rsd_inventory_group }}]" 105 | state: present 106 | 107 | - name: Append node IPv4 to inventory under "[{{ rsd_inventory_group }}]" group 108 | lineinfile: 109 | dest: "{{ rsd_output_path }}/inventory" 110 | line: "{{ output.node.Details.Interfaces[0].IPv4Addresses[0] }}" 111 | state: present 112 | insertafter: "[{{ rsd_inventory_group }}]" 113 | 114 | - name: Create inventory key for "[all]" group 115 | lineinfile: 116 | dest: "{{ rsd_output_path }}/inventory" 117 | line: "[all]" 118 | state: present 119 | insertafter: EOF 120 | 121 | - name: Append node IPv4 to inventory under "[all]" group 122 | lineinfile: 123 | dest: "{{ rsd_output_path }}/inventory" 124 | line: "{{ output.node.Details.Interfaces[0].IPv4Addresses[0] }}" 125 | state: present 126 | insertafter: "[all]" 127 | when: rsd_write_to_files 128 | -------------------------------------------------------------------------------- /library/rsd_power.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | 3 | ####################################################### 4 | # Copyright (c) 2019 Intel Corporation. All rights reserved. 5 | # 6 | # GNU General Public License v3.0+ 7 | # (see LICENSE.GPL or https://www.gnu.org/licenses/gpl-3.0.txt) 8 | # 9 | # Authors: 10 | # - Radoslaw Kuschel - 11 | ####################################################### 12 | 13 | from __future__ import absolute_import, division, print_function 14 | __metaclass__ = type 15 | 16 | 17 | ANSIBLE_METADATA = { 18 | 'metadata_version': '1.1', 19 | 'status': ['preview'], 20 | 'supported_by': 'community' 21 | } 22 | 23 | DOCUMENTATION = ''' 24 | --- 25 | module: rsd_power 26 | 27 | short_description: Change power state of RSD Composed Nodes 28 | 29 | version_added: "2.6" 30 | 31 | description: 32 | - Change the power state of composed node. 33 | - The module supports the 'on', 'off' and 'restarted' power states, which 34 | are equivalent to 'on', 'graceful shutdown', 'graceful restart'. 35 | - The module also support force flag which is equivalent to 36 | 'force on', 'force off', 'force restart'. 37 | - "The node on which power action will be performed can by identify by 38 | one of the following: uuid, identity, or name." 39 | 40 | options: 41 | id: 42 | description: 43 | - Specify the node to act on by specifying 'type' for type of 44 | identification key and 'value' for its value. 45 | required: true 46 | suboptions: 47 | type: 48 | type: str 49 | description: 50 | - Specify type of identification. For best performance 51 | it is suggested to use identity as type. 52 | required: false 53 | default: identity 54 | choices: [identity, uuid, name] 55 | value: 56 | type: str 57 | description: 58 | - Identification signature. 59 | required: true 60 | state: 61 | description: 62 | - Desired power action to be performed on the node. 63 | required: true 64 | choices: ['on', 'off', 'restarted'] 65 | force: 66 | description: 67 | - Force power action on the node 68 | required: false 69 | default: false 70 | 71 | extends_documentation_fragment: 72 | - rsd 73 | 74 | author: 75 | - Radoslaw Kuschel 76 | ''' 77 | EXAMPLES = ''' 78 | --- 79 | - name: Restart Node by specifying node id. 80 | rsd_power: 81 | id: 82 | value: 1 83 | state: restarted 84 | 85 | - name: Shutdown node by specifying node uuid. 86 | rsd_power: 87 | id: 88 | value: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee 89 | type: uuid 90 | state: off 91 | 92 | - name: Force shutdown of Node by specifying node name. 93 | rsd_power: 94 | id: 95 | value: test_node 96 | type: name 97 | state: off 98 | force: true 99 | 100 | ''' 101 | 102 | RETURN = ''' 103 | node: 104 | description: Information regarding the node 105 | returned: On success 106 | type: complex 107 | contains: 108 | id: 109 | description: Node ID. 110 | name: 111 | description: Node name. 112 | uuid: 113 | description: Node uuid. 114 | required_power_action: 115 | description: Print power action specified by user. 116 | previus_power_state: 117 | description: Previous power state of the node. 118 | possible_power_actions: 119 | description: Print supported power actions of the node. 120 | 121 | sample: 122 | "id": "1", 123 | "name": "node_test", 124 | "previous_power_state": "on", 125 | "requested_power_action": "force restart", 126 | "supported_power_action": [ 127 | "graceful restart", 128 | "on", 129 | "force off", 130 | "graceful shutdown", 131 | "force restart" 132 | ], 133 | "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" 134 | ''' 135 | 136 | from ansible.module_utils.rsd_common import RSD 137 | try: 138 | import rsd_lib 139 | import sushy 140 | except ImportError: 141 | pass 142 | 143 | 144 | class RsdNodePower(RSD): 145 | 146 | def __init__(self): 147 | argument_spec = dict( 148 | id=dict( 149 | type='dict', 150 | required=True, 151 | options=dict( 152 | type=dict( 153 | type='str', 154 | required=False, 155 | choices=['name', 'identity', 'uuid'], 156 | default='identity' 157 | ), 158 | value=dict( 159 | type='str', 160 | required=True 161 | ) 162 | ) 163 | ), 164 | state=dict( 165 | type='str', 166 | required=True, 167 | choices=['on', 'off', 'restarted'] 168 | ), 169 | force=dict( 170 | type='bool', 171 | required=False, 172 | default=False 173 | ) 174 | ) 175 | 176 | super(RsdNodePower, self).__init__(argument_spec, False) 177 | 178 | def _convert_power_param(self): 179 | params = self.module.params 180 | mappings = { 181 | 'on': ('On', 'ForceOn'), 182 | 'off': ('GracefulShutdown', 'ForceOff'), 183 | 'restarted': ('GracefulRestart', 'ForceRestart') 184 | } 185 | 186 | if params['force']: 187 | power_state = mappings[params['state']][1] 188 | else: 189 | power_state = mappings[params['state']][0] 190 | 191 | return power_state 192 | 193 | def _check_state_is_allowed(self, node, requested_state): 194 | compute_reset_values = node.get_allowed_reset_node_values() 195 | 196 | if requested_state not in compute_reset_values: 197 | self.module.fail_json( 198 | msg="This node does not support such power action: " 199 | "'{0}'. The node supports following power actions: " 200 | "{1}".format(requested_state, compute_reset_values)) 201 | 202 | def _reset_node(self, node, power_state): 203 | try: 204 | node.reset_node(power_state) 205 | return self._return_power_result(node, True, power_state) 206 | except sushy.exceptions.ServerSideError: 207 | same_as = { 208 | 'On': ('On', 'ForceOn'), 209 | 'Off': ('GracefulShutdown', 'ForceOff') 210 | } 211 | 212 | node.refresh() 213 | current_state = node.power_state 214 | 215 | if power_state in same_as[current_state]: 216 | return self._return_power_result(node, False, power_state) 217 | else: 218 | self.module.fail_json(msg="Reset action failed. The required " 219 | "transition might not be supported") 220 | 221 | def _return_power_result(self, node, changed, requested_state): 222 | result = dict() 223 | result["id"] = node.identity 224 | result["name"] = node.name 225 | result["uuid"] = node.uuid 226 | result["requested_power_action"] = requested_state 227 | result["previous_power_state"] = node.power_state 228 | result["supported_power_action"] = node.get_allowed_reset_node_values() 229 | self.module.exit_json(changed=changed, node=result) 230 | 231 | def run(self): 232 | node = self._get_node() 233 | requested_state = self._convert_power_param() 234 | self._check_state_is_allowed(node, requested_state) 235 | self._reset_node(node, requested_state) 236 | 237 | 238 | def main(): 239 | power = RsdNodePower() 240 | power.run() 241 | 242 | 243 | if __name__ == '__main__': 244 | main() 245 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | DISCONTINUATION OF PROJECT 2 | 3 | This project will no longer be maintained by Intel. 4 | 5 | Intel has ceased development and contributions including, but not limited to, maintenance, bug fixes, new releases, or updates, to this project. 6 | 7 | Intel no longer accepts patches to this project. 8 | 9 | If you have an ongoing need to use this project, are interested in independently developing it, or would like to maintain patches for the open source software community, please create your own fork of this project. 10 | 11 | Contact: webadmin@linux.intel.com 12 | This feature is no longer supported by Intel 13 | 14 | ansible-rsd-provisioning 15 | ========= 16 | 17 | This repository hosts “Intel® Rack Scale Design (RSD) Provisioning for Ansible*” . The code herein available allows a data center administrator or higher-level 18 | orchestration tool to make use of Ansible* for provisioning Intel® RSD clusters managed by an Intel® RSD compliant POD Manager. 19 | 20 | This role provisions a user-defined amount of nodes and saves their actual hardware details resulting from the composition to a file for subsequent reuse. An additional inventory file is also created grouping the IP address of each composed node under a user-defined group name. Multiple runs of the the role will keep appending to this inventory file. 21 | 22 | Composition and booting of composed nodes is possible thanks two modules, `rsd_compose` and `rsd_power`, bundled with the role, which support respectively: 23 | 24 | - Allocation, assembly and deletion of composed nodes; the specifications and values here allow to enumerate hardware selection, ranging from RAM and CPU, to NVME or FPGA devices over Fabric (see the [Intel® PODM API specification](https://www.intel.com/content/www/us/en/architecture-and-technology/rack-scale-design/podm-api-spec-v2-4.html) for a detailed list). 25 | - Changing the power state of composed nodes, from power on to reboot. 26 | 27 | Once the role is installed and executed at least once, the above two modules can be used in any subsequent task or role, granting access to the full range of their functionality. 28 | 29 | Composition requirements of the nodes for this role are controlled through a number of predefined variables detailed below. Interaction with PODM requires endpoint and authentication values, also detailed below. 30 | 31 | Please note that this role isn't idempotent. 32 | 33 | This role supports Intel® RSD 2.3.x and 2.4.0 versions. 34 | 35 | 36 | “*Other names and brands may be claimed as the property of others”. 37 | 38 | Requirements 39 | ------------ 40 | 41 | - `rsd-lib >= 1.0.0` 42 | - an Intel® RSD compliant POD Manager 43 | - Intel® RSD compliant composable hardware 44 | 45 | At least [rsd-lib](https://github.com/openstack/rsd-lib) version of 1.0.0 is required: 46 | ``` 47 | $ sudo pip install git+https://github.com/openstack/rsd-lib.git 48 | ``` 49 | 50 | Role Variables 51 | -------------- 52 | 53 | Variables needed to run and control this role can be divided into three main categories: 54 | - PODM related; There are two variable groups, one for connection related information and a second one for the credentials. They are read via environment variables, as follows: 55 | - `PODM_HOST`: specify PODM IP address. 56 | - `PODM_PORT`: specify port to connect to. 57 | - `PODM_USERNAME`: specify username for PODM authentication. 58 | - `PODM_PASSWORD`: specify password for PODM authentication. 59 | 60 | An additional variable is available in the role at [defaults/main/podm.yml](defaults/main/podm.yml), `podm_validate_cert`, to control whether to perform the SSL certificate validation (default False). 61 | 62 | - output related, to control file generation for the resulting output; default values can be found in [defaults/main/output.yml](defaults/main/output.yml). 63 | - `rsd_output_path`: base directory for storing output files, by default in the same location as the playbook. 64 | - `rsd_inventory_group`: group name used in the inventory file to group IPs of the composed (default "rsd_nodes"). 65 | - `rsd_write_to_file`: control variable to enable output and inventory file creation (default: True); node details are still be available as a fact under `rsd_node_info`. 66 | 67 | 68 | - nodes related, mostly to define composition requirements; default values can be found in [defaults/main/composition.yml](defaults/main/composition.yml). A similar file ([files/requirements_example.yml](files/requirements_example.yml)) containing the same variables with documentation and sample values, can be copied, edited and easily included in your playbook through the `include_vars` directive. Following is a table of the variables defined for node composition: 69 | 70 | 71 | | Variable | Default value | Description | 72 | |----------|:-------------:|-------------| 73 | |`number_of_nodes_to_provision`| 10 | Number of nodes to be created by the role | 74 | |`rsd_node_name`| node | Name assigned to the composed node | 75 | |`rsd_node_description`| "Composed Node" | A short text description associated to node | 76 | |`rsd_node_cores`| 0 | The composed node will have at lest the amount CPU cores here specified, potentially accross multiple CPUs. | 77 | |`rsd_node_memory`| 0 | Minimum amount of memory for the whole system, in MiB unit | 78 | |`rsd_node_memory_spec`| empty | List of Processors (CPUs or FPGAs) and their specification (e.g. Frequency) | 79 | |`rsd_node_local_drives`| empty | List of local drives to assigned to the node and their specifications, such as capacity, type and interface | 80 | |`rsd_node_remote_drives`| empty | List of remote drives to assigned to the node and their specifications, such as capacity, type and interface | 81 | |`rsd_node_eth_interfaces`| empty | List of interfaces and their desired specifications, such as their desired link speed | 82 | |`rsd_node_state`| assembled | Final state for the composed node. Alternative values are: 'absent', 'allocated' | 83 | 84 | For more details on the available resource specification please refer to the [Intel® RSD PODM API specification](https://www.intel.com/content/www/us/en/architecture-and-technology/rack-scale-design/podm-api-spec-v2-4.html). 85 | 86 | 87 | Dependencies 88 | ------------ 89 | 90 | None 91 | 92 | 93 | Example Playbook 94 | ---------------- 95 | 96 | to learn more about modules and how they could be used please see the documentation and examples included with the modules. See `library/rsd_compose.py` to learn more about `rsd_compose` module and `library/rsd_power.py` to learn more about `rsd_power` module. Before running playbook make sure to export PODM authentication variables. 97 | 98 | Example export of PODM authentication variables: 99 | 100 | export PODM_HOST=127.0.0.1 101 | export PODM_PORT=8443 102 | export PODM_USERNAME=admin 103 | export PODM_PASSWORD=password 104 | 105 | Example playbook using this role: 106 | 107 | - hosts: localhost 108 | connection: local 109 | roles: 110 | - intel.ansible_rsd_provisioning 111 | 112 | Example playbook for the rsd_compose module specifying requirements inline: 113 | 114 | - hosts: localhost 115 | connection: local 116 | gather_facts: no 117 | tasks: 118 | - name: Assemble a node from the specified info/requirements 119 | rsd_compose: 120 | spec: 121 | name: Test node 122 | description: Node for testing assemble 123 | total_mem: 8000 124 | processors: 125 | - ProcessorType: CPU 126 | AchievableSpeedMHz: 3000 127 | state: assembled 128 | podm: 129 | validate_cert: True 130 | 131 | Example playbook for the rsd_compose module using a spec file with requirements: 132 | 133 | - hosts: localhost 134 | connection: local 135 | gather_facts: no 136 | tasks: 137 | - name: Assemble a node from a PODM compliant JSON info/requirements file 138 | rsd_compose: 139 | specfile: files/simple_specfile.json 140 | power_on: false 141 | state: assembled 142 | 143 | Example playbook for the rsd_power module: 144 | 145 | - hosts: localhost 146 | connection: local 147 | gather_facts: no 148 | tasks: 149 | - name: Trigger node reboot 150 | rsd_power: 151 | id: 152 | value: 1 153 | type: identity 154 | state: restarted 155 | force: false 156 | 157 | Example playbook for rsd_boot module: 158 | 159 | - hosts: localhost 160 | connection: local 161 | gather_facts: no 162 | tasks: 163 | - name: Override Boot options to boot once from remote drive in legacy mode. 164 | rsd_boot: 165 | id: 166 | value: 1 167 | boot_target: remote_drive 168 | boot_enable: once 169 | boot_mode: legacy 170 | 171 | More examples can be found in the [examples](examples) directory of the role. 172 | 173 | License 174 | ------- 175 | 176 | The role is provided under the Apache 2.0 license. The included modules and 177 | related code (doc fragments and module utils) are released under GPLv3+. 178 | 179 | Author Information 180 | ------------------ 181 | 182 | - Marco Chiappero - 183 | - Radoslaw Kuschel - 184 | - Igor D.C. - 185 | -------------------------------------------------------------------------------- /module_utils/rsd_common.py: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2019 Intel Corporation. All rights reserved. 2 | # 3 | # GNU General Public License v3.0+ 4 | # (see LICENSE.GPL or https://www.gnu.org/licenses/gpl-3.0.txt) 5 | # 6 | # Authors: 7 | # - Igor D.C. - 8 | # - Marco Chiappero - 9 | ####################################################### 10 | 11 | from __future__ import absolute_import, division, print_function 12 | 13 | __metaclass__ = type 14 | 15 | from ansible.module_utils.basic import env_fallback 16 | from ansible.module_utils.basic import AnsibleModule 17 | 18 | try: 19 | import rsd_lib 20 | import sushy 21 | HAS_RSDLIB = True 22 | except ImportError: 23 | HAS_RSDLIB = False 24 | 25 | 26 | class RSD(object): 27 | 28 | class PodmInfo(object): 29 | 30 | def __init__(self): 31 | self._host = None 32 | self._port = 8443 33 | self._protocol = 'http' 34 | self._verify_cert = False 35 | 36 | @property 37 | def host(self): 38 | return self._host 39 | 40 | @host.setter 41 | def host(self, value): 42 | if value and isinstance(value, str): 43 | self._host = value 44 | else: 45 | raise ValueError("Invalid hostname") 46 | 47 | @property 48 | def port(self): 49 | return self._port 50 | 51 | @port.setter 52 | def port(self, value): 53 | if 1 < value and value <= 65535: 54 | self._port = value 55 | else: 56 | raise ValueError("Invalid port number") 57 | 58 | @property 59 | def protocol(self): 60 | return self._protocol 61 | 62 | @protocol.setter 63 | def protocol(self, value): 64 | if value.lower() in ['https', 'http']: 65 | self._protocol = value 66 | else: 67 | raise ValueError("Must be a http or https") 68 | 69 | @property 70 | def verify_cert(self): 71 | return self._verify_cert 72 | 73 | @verify_cert.setter 74 | def verify_cert(self, value): 75 | self._verify_cert = value 76 | 77 | def is_valid(self): 78 | if self._host and self._port: 79 | return True 80 | 81 | return False 82 | 83 | def to_url(self): 84 | endpoint = "/redfish/v1" # might be influenced by 85 | 86 | return "{0}://{1}:{2}{3}".format( 87 | self._protocol, self._host, self._port, endpoint) 88 | 89 | class AuthInfo(): 90 | 91 | def __init__(self): 92 | self.username = None 93 | self.password = None 94 | 95 | RSD_BACKEND_ARGS = dict( 96 | id=dict( 97 | type='dict', 98 | required=True, 99 | options=dict( 100 | type=dict( 101 | type='str', 102 | required=False, 103 | choices=['name', 'identity', 'uuid'], 104 | default='identity' 105 | ), 106 | value=dict( 107 | type='str', 108 | required=True 109 | ) 110 | ) 111 | ), 112 | podm=dict( 113 | type='dict', 114 | apply_defaults=True, 115 | options=dict( 116 | host=dict( 117 | type='str', 118 | fallback=(env_fallback, ['PODM_HOST']), 119 | required=True, 120 | aliases=['hostname'] 121 | ), 122 | port=dict( 123 | type='int', 124 | fallback=(env_fallback, ['PODM_PORT']), 125 | default=443, 126 | ), 127 | protocol=dict( 128 | type='str', 129 | default='https', 130 | choices=['https', 'http'] 131 | ), 132 | validate_cert=dict( 133 | type='bool', 134 | default=False, 135 | aliases=['verify_cert'] 136 | ), 137 | ), 138 | ), 139 | auth=dict( 140 | type='dict', 141 | apply_defaults=True, 142 | options=dict( 143 | username=dict( 144 | type='str', 145 | fallback=(env_fallback, ['PODM_USERNAME']), 146 | required=True, 147 | no_log=True, 148 | aliases=['user'] 149 | ), 150 | password=dict( 151 | type='str', 152 | fallback=(env_fallback, ['PODM_PASSWORD']), 153 | required=True, 154 | no_log=True, 155 | aliases=['pass'] 156 | ), 157 | ), 158 | ) 159 | ) 160 | 161 | def __init__(self, argument_spec, bypass_checks=False, no_log=False, 162 | check_invalid_arguments=None, mutually_exclusive=None, 163 | required_together=None, required_one_of=None, 164 | add_file_common_args=False, supports_check_mode=False, 165 | required_if=None): 166 | 167 | full_arg_spec = dict() 168 | full_arg_spec.update(RSD.RSD_BACKEND_ARGS) # args spec to this class 169 | full_arg_spec.update(argument_spec) # args from derived class 170 | 171 | self.module = AnsibleModule( 172 | argument_spec=full_arg_spec, 173 | supports_check_mode=supports_check_mode, 174 | bypass_checks=bypass_checks, 175 | no_log=no_log, 176 | add_file_common_args=add_file_common_args, 177 | check_invalid_arguments=check_invalid_arguments, 178 | mutually_exclusive=mutually_exclusive, 179 | required_together=required_together, 180 | required_if=required_if, 181 | required_one_of=required_one_of 182 | ) 183 | 184 | if not HAS_RSDLIB: 185 | self.module.fail_json(msg='The rsd-lib Python module is required') 186 | 187 | podm, credentials = self._parse_connection_info() 188 | self._connect(podm, credentials) 189 | 190 | self.module.debug("rsd-lib setup completed") 191 | 192 | def _parse_connection_info(self): 193 | endpoint = RSD.PodmInfo() 194 | podm_info = self.module.params['podm'] 195 | endpoint.host = podm_info['host'] 196 | endpoint.port = podm_info['port'] 197 | endpoint.protocol = podm_info['protocol'] 198 | endpoint.verify_cert = podm_info['validate_cert'] 199 | 200 | if not endpoint.host: 201 | self.module.fail_json(msg='Missing PODM connection info') 202 | 203 | credentials = RSD.AuthInfo() 204 | auth_info = self.module.params['auth'] 205 | credentials.username = auth_info['username'] 206 | credentials.password = auth_info['password'] 207 | 208 | if not credentials.username or not credentials.password: 209 | self.module.fail_json(msg='Missing endpoint credentials') 210 | 211 | return endpoint, credentials 212 | 213 | def _connect(self, podm_info, auth_info): 214 | if not podm_info.is_valid(): 215 | raise ValueError("Invalid PODM info") 216 | 217 | try: 218 | self.rsd = rsd_lib.RSDLib( 219 | base_url=podm_info.to_url(), 220 | verify=podm_info.verify_cert, 221 | username=auth_info.username, 222 | password=auth_info.password 223 | ).factory() 224 | except (sushy.exceptions.ResourceNotFoundError, 225 | sushy.exceptions.ConnectionError, 226 | sushy.exceptions.HTTPError) as e: 227 | self.module.fail_json( 228 | msg="Failed to setup and endpoint connection: {0}".format( 229 | str(e))) 230 | 231 | self.module.debug("Connection with PODM established") 232 | 233 | def _get_nodes_collection(self): 234 | return self.rsd.get_node_collection().get_members() 235 | 236 | def _get_node(self): 237 | params = self.module.params 238 | type = params['id']['type'] 239 | value = params['id']['value'] 240 | 241 | if type == 'identity': 242 | node_uri = "v1/Nodes/" + str(value) 243 | try: 244 | return self.rsd.get_node(node_uri) 245 | except sushy.exceptions.ResourceNotFoundError: 246 | self.module.fail_json( 247 | msg="There is no node with such ID: {0}".format(value)) 248 | else: 249 | nodes = self._get_nodes_collection() 250 | 251 | if type == 'name': 252 | node_match = [n for n in nodes if n.name == value] 253 | 254 | if len(node_match) == 1: 255 | return node_match[0] 256 | elif len(node_match) > 1: 257 | self.module.fail_json(msg="Multiple nodes found with " 258 | "given name: {0}".format(value)) 259 | 260 | elif type == 'uuid': 261 | for n in nodes: 262 | if n.uuid == value: 263 | return n 264 | 265 | # not found 266 | self.module.fail_json(msg="There is no node with id type '{0}' " 267 | "and value: '{1}'".format(type, value)) 268 | -------------------------------------------------------------------------------- /library/rsd_boot.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | 3 | ####################################################### 4 | # Copyright (c) 2019 Intel Corporation. All rights reserved. 5 | # 6 | # GNU General Public License v3.0+ 7 | # (see LICENSE.GPL or https://www.gnu.org/licenses/gpl-3.0.txt) 8 | # 9 | # Authors: 10 | # - Radoslaw Kuschel - 11 | ####################################################### 12 | 13 | from __future__ import absolute_import, division, print_function 14 | __metaclass__ = type 15 | 16 | ANSIBLE_METADATA = { 17 | 'metadata_version': '1.1', 18 | 'status': ['preview'], 19 | 'supported_by': 'community' 20 | } 21 | 22 | DOCUMENTATION = ''' 23 | --- 24 | module: rsd_boot 25 | 26 | short_description: Change node Boot properties 27 | 28 | version_added: "2.6" 29 | 30 | description: 31 | - rsd_boot module override node boot properties. 32 | - The node on which boot override action will be performed can 33 | be identify by one of the following: uuid, identity, or name. 34 | 35 | options: 36 | boot_target: 37 | description: 38 | - Boot source to be used at next boot instead of the 39 | normal boot device. 40 | - 'none': boot from normal boot device. 41 | - 'pxe': boot from PXE environment. 42 | - 'floppy': Boot from the floppy disk drive. 43 | - 'cd': Boot from CD/DVD disc. 44 | - 'usb': Boot from a USB device. 45 | - 'hdd' boot from a hard drive. 46 | - 'bios_setup': Boot from BIOS setup utility. 47 | - 'utilities': Boot manufacturer's utilities programs. 48 | - 'diags': Boot manufacturer's diagnostics programs. 49 | - 'uefi_shell': Boot to the UEFI shell. 50 | - 'uefi_target': Boot to the UEFI device. 51 | - 'sd_card': Boot from an SD card. 52 | - 'uefi_http': Boot from UEFI HTTP network location. 53 | - 'remote_drive': boot from remote drive. 54 | required: true 55 | choices: ['none', 'pxe', 'floppy', 'cd', 'usb', 'hdd', 56 | 'bios_setup', 'utilities', 'diags', 'uefi_shell', 57 | 'uefi_target', 'sd_card', 'uefi_http', 'remote_drive'] 58 | boot_enable: 59 | description: 60 | - Set state of the boot source override feature. 61 | - 'disable': The system will boot as normal. 62 | - 'once': System will boot once on the next boot cycle. 63 | - 'continuous': System will boot continuously from given 64 | boot source. 65 | required: true 66 | choices: ['disable', 'once', 'continuous'] 67 | boot_mode: 68 | description: 69 | - Set BIOS boot mode 70 | - 'legacy': Node will boot in non-UEFI boot mode. 71 | - 'uefi': None will boot in UEFI boot mode. 72 | required: true 73 | choices: ['legacy', 'uefi'] 74 | 75 | extends_documentation_fragment: 76 | - rsd 77 | 78 | author: 79 | - Radoslaw Kuschel 80 | ''' 81 | EXAMPLES = ''' 82 | --- 83 | - name: Override Boot options to boot once from remote drive in legacy mode. 84 | rsd_boot: 85 | id: 86 | value: 1 87 | boot_target: remote_drive 88 | boot_enable: once 89 | boot_mode: legacy 90 | 91 | - name: Override Boot options to boot once from PXE boot in UEFI mode. 92 | rsd_boot: 93 | id: 94 | value: 1 95 | boot_target: pxe 96 | boot_enable: once 97 | boot_mode: uefi 98 | 99 | ''' 100 | 101 | RETURN = ''' 102 | node: 103 | description: Information regarding the node. 104 | returned: On success 105 | type: complex 106 | contains: 107 | id: 108 | description: Node ID. 109 | name: 110 | description: Node name. 111 | uuid: 112 | description: Node uuid. 113 | previous_boot_target: 114 | description: Previous boot source. 115 | previous_boot_enable: 116 | description: Previous state of the boot source. 117 | previous_boot_mode: 118 | description: Previous BIOS boot mode. 119 | requested_boot_target: 120 | description: Requested boot source. 121 | requested_boot_enable: 122 | description: Requested state of the boot source. 123 | requested_boot_mode: 124 | description: Requested BIOS boot mode. 125 | 126 | sample: 127 | "id": "1", 128 | "name": "node_01", 129 | "previous_boot_enable": "Continuous", 130 | "previous_boot_mode": "Legacy", 131 | "previous_boot_target": "Hdd", 132 | "requested_boot_enable": "Once", 133 | "requested_boot_mode": "Legacy", 134 | "requested_boot_target": "Pxe", 135 | "uuid": "254bbb38-b98c-46a0-af5f-bef452854061" 136 | ''' 137 | 138 | from ansible.module_utils.rsd_common import RSD 139 | try: 140 | import rsd_lib 141 | import sushy 142 | except ImportError: 143 | pass 144 | 145 | 146 | class RsdNodeBoot(RSD): 147 | 148 | def __init__(self): 149 | argument_spec = dict( 150 | boot_target=dict( 151 | type='str', 152 | required=True, 153 | choices=['none', 'pxe', 'floppy', 'cd', 'usb', 'hdd', 154 | 'bios_setup', 'utilities', 'diags', 'uefi_shell', 155 | 'uefi_target', 'sd_card', 'uefi_http', 'remote_drive'] 156 | ), 157 | 158 | boot_enable=dict( 159 | type='str', 160 | required=True, 161 | choices=['disable', 'once', 'continuous'] 162 | ), 163 | 164 | boot_mode=dict( 165 | type='str', 166 | required=False, 167 | choices=['legacy', 'uefi'] 168 | ), 169 | ) 170 | 171 | super(RsdNodeBoot, self).__init__(argument_spec, False) 172 | 173 | def _params_mappings(self, param): 174 | mappings = { 175 | 'none': 'None', 176 | 'pxe': 'Pxe', 177 | 'floppy': 'Floppy', 178 | 'cd': 'Cd', 179 | 'usb': 'Usb', 180 | 'hdd': 'Hdd', 181 | 'bios_setup': 'BiosSetup', 182 | 'utilities': 'Utilities', 183 | 'diags': 'Diags', 184 | 'uefi_shell': 'UefiShell', 185 | 'uefi_target': 'UefiTarget', 186 | 'sd_card': 'SDCard', 187 | 'uefi_http': 'UefiHttp', 188 | 'remote_drive': 'RemoteDrive', 189 | 'disable': 'Disable', 190 | 'once': 'Once', 191 | 'continuous': 'Continuous', 192 | 'legacy': 'Legacy', 193 | 'uefi': 'UEFI' 194 | } 195 | 196 | param_keys = ['boot_target', 'boot_enable', 'boot_mode'] 197 | requested_val = dict() 198 | 199 | for key in param_keys: 200 | value = param[key] 201 | if value: 202 | requested_val[key] = mappings[value] 203 | 204 | return requested_val 205 | 206 | def _get_current_node_boot_options(self, node): 207 | node_boot_opt = node.boot 208 | current_boot_opt = { 209 | 'boot_target': node_boot_opt.boot_source_override_target, 210 | 'boot_enable': node_boot_opt.boot_source_override_enabled, 211 | 'boot_mode': node_boot_opt.boot_source_override_mode 212 | } 213 | 214 | return current_boot_opt 215 | 216 | def _return_boot_result(self, node, current_opt, requested_opt, 217 | boot_options_diff): 218 | result = dict() 219 | 220 | if 'boot_mode' not in requested_opt: 221 | requested_opt['boot_mode'] = current_opt['boot_mode'] 222 | 223 | result = dict() 224 | result["id"] = node.identity 225 | result["name"] = node.name 226 | result["uuid"] = node.uuid 227 | result["current"] = requested_opt 228 | result["previous"] = current_opt 229 | 230 | self.module.exit_json(changed=boot_options_diff, node=result) 231 | 232 | def _check_boot_opt_diff(self, current_boot_opt, requested_boot_opt): 233 | 234 | for attr in requested_boot_opt: 235 | if current_boot_opt[attr] != requested_boot_opt[attr]: 236 | return True 237 | 238 | return False 239 | 240 | def _change_boot_options(self, param, node): 241 | requested_opt = self._params_mappings(param) 242 | current_boot_opt = self._get_current_node_boot_options(node) 243 | boot_opt_diff = self._check_boot_opt_diff(current_boot_opt, 244 | requested_opt) 245 | 246 | if boot_opt_diff is True: 247 | try: 248 | if param['boot_mode'] is None: 249 | node.set_node_boot_source( 250 | requested_opt['boot_target'], 251 | enabled=requested_opt['boot_enable']) 252 | else: 253 | node.set_node_boot_source( 254 | requested_opt['boot_target'], 255 | enabled=requested_opt['boot_enable'], 256 | mode=requested_opt['boot_mode']) 257 | except (sushy.exceptions.InvalidParameterValueError) as e: 258 | self.module.fail_json(msg="Invalid Parameter: " 259 | "{0}".format(str(e))) 260 | 261 | self._return_boot_result(node, current_boot_opt, requested_opt, 262 | boot_opt_diff) 263 | 264 | def run(self): 265 | params = self.module.params 266 | node = self._get_node() 267 | self._change_boot_options(params, node) 268 | 269 | 270 | def main(): 271 | boot = RsdNodeBoot() 272 | boot.run() 273 | 274 | 275 | if __name__ == '__main__': 276 | main() 277 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | -------------------------------------------------------------------------------- /library/rsd_compose.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | 3 | ####################################################### 4 | # Copyright (c) 2019 Intel Corporation. All rights reserved. 5 | # 6 | # GNU General Public License v3.0+ 7 | # (see LICENSE.GPL or https://www.gnu.org/licenses/gpl-3.0.txt) 8 | # 9 | # Authors: 10 | # - Marco Chiappero - 11 | ####################################################### 12 | 13 | from __future__ import absolute_import, division, print_function 14 | 15 | __metaclass__ = type 16 | 17 | 18 | ANSIBLE_METADATA = { 19 | 'metadata_version': '1.1', 20 | 'status': ['preview'], 21 | 'supported_by': 'community' 22 | } 23 | 24 | DOCUMENTATION = ''' 25 | --- 26 | module: rsd_compose 27 | 28 | short_description: Manages the life cycle of Rack Scale Design composed 29 | resources 30 | 31 | description: 32 | - Allocate/Assemble/Destroy Rack Scale Design Composed Nodes. 33 | - Non-absent nodes may be called "composed" within this source file, i.e., 34 | nodes that are either allocated or assembled but the distinction 35 | wouldn't matter under the context. 36 | 37 | version_added: "2.6" 38 | 39 | author: 40 | - Marco Chiappero 41 | 42 | options: 43 | id: 44 | description: 45 | - Specify the node to act on by specifying 'type' for type of 46 | identification key and 'value' for its value. 47 | required: false 48 | suboptions: 49 | type: 50 | type: str 51 | description: 52 | - Specify type of identification. For best performance 53 | it is suggested to use identity as type. 54 | required: false 55 | default: identity 56 | choices: [identity, uuid, name] 57 | value: 58 | type: str 59 | description: 60 | - Identification signature. 61 | required: true 62 | spec: 63 | description: 64 | - Enumerate the desired resources for allocating or assembling a 65 | node. It's incompatible with I(id) and I(specfile). Each 66 | sub-option can express PODM API compliant specifications in 67 | either JSON or YAML format. Refer to the PODM API specification 68 | for a complete list of available options. 69 | required: false 70 | suboptions: 71 | name: 72 | type: str 73 | description: 74 | - Name for the composed node 75 | description: 76 | type: str 77 | description: 78 | - Description of the composed node 79 | processors: 80 | type: json 81 | description: 82 | - List of processors and related requirements 83 | memory: 84 | type: json 85 | description: 86 | - List of memory modules and related requirements 87 | local_drives: 88 | type: json 89 | description: 90 | - A list of local drives and related requirements 91 | remote_drives: 92 | type: json 93 | description: 94 | - A list of remote drives and related requirements 95 | eth_ifaces: 96 | type: json 97 | description: 98 | - A list of ethernet interfaces and related requirements 99 | security: 100 | type: dict 101 | description: 102 | - Security specifications 103 | # oem: 104 | # type: dict 105 | # description: 106 | # - OEM specific features 107 | total_cores: 108 | type: int 109 | description: 110 | - Total core count for the whole composed node 111 | total_memory: 112 | type: int 113 | description: 114 | - Total memory amount for the whole composed node 115 | 116 | specfile: 117 | description: 118 | - Execute this task even if it requires deleting a Composed Node 119 | - This option is mutually exclusive with I(spec) and I(id) 120 | type: path 121 | aliases: 122 | - 'file' 123 | 124 | state: 125 | description: 126 | - Assert the desired state for the composed node, whether such node 127 | is described by I(spec), I(specfile) or I(id). I(state=allocated) 128 | will try to allocate a node as described in I(spec) or 129 | I(specfile). I(state=assembled) will try to first allocate and 130 | then assemble a node as described in I(spec) or I(specfile), or 131 | assemble a pre-allocated node referenced by I(id). An existing 132 | allocated or assembled node specified by I(id) can be decomposed 133 | and its resources released by requesting I(state=absent). 134 | choices: [allocated, assembled, absent] 135 | default: assembled 136 | required: false 137 | 138 | extends_documentation_fragment: 139 | - rsd 140 | 141 | requirements: 142 | - enum34 or Python >= 3.4 143 | 144 | notes: 145 | - Due to the nature of the PODM API, check mode cannot be supported 146 | - For the same reason the module is not idempotent at the moment, since any 147 | result depends on decisions actually made by PODM 148 | - While modules should not require that a user know all the underlying 149 | options of an API/tool to be used, PODM API contains multiple nested 150 | levels that would be difficult to capture anyway. Moreover the API is 151 | still under heavy development and the use of a 'catch-all' spec/specfile 152 | option, promotes forward compatibility while delegating up-to-date value 153 | checking to rsd-lib. 154 | ''' 155 | 156 | EXAMPLES = ''' 157 | --- 158 | - name: Allocate a node with the provided specs 159 | rsd_compose: 160 | spec: 161 | processors: 162 | - ProcessorType: CPU 163 | AchievableSpeedMHz: 3000 164 | - ProcessorType: FPGA 165 | Connectivity: RemotePCIe 166 | local_drives: 167 | - Type: SSD 168 | remote_drives: 169 | - CapacityGiB: 60 170 | Protocol: iScsi 171 | - CapacityGiB: 80 172 | Protcol: NVMeOverFabrics 173 | state: allocated 174 | register: result 175 | 176 | - name: Assemble the allocated node 177 | rsd_compose: 178 | id: 179 | value: result.node.Id 180 | state: assembled 181 | 182 | - name: Delete the previously assembled 183 | rsd_compose: 184 | id: 185 | value: result.node.Id 186 | state: absent 187 | 188 | - name: Assemble a node from spec file 189 | rsd_compose: 190 | specfile: /path/to/my_node_spec.json 191 | podm: 192 | host: 192.168.0.1 193 | port: 12345 194 | 195 | - name: Allocate a node using JSON formatted specs 196 | rsd_compose: 197 | spec: 198 | processors: [{ ProcessorType: CPU, AchievableSpeedMHz: 3000 }] 199 | remote_drives: [{ CapacityGiB: 60, Protocol: iScsi }] 200 | state: allocated 201 | ''' 202 | 203 | RETURN = ''' 204 | --- 205 | # request: 206 | # description: In the case of a composition request, provide the full spec 207 | # as provided by the user via either I(spec) or I(specfile) 208 | # returned: On success 209 | # type: complex 210 | 211 | node: 212 | description: Complete description of the node 213 | returned: On success 214 | type: complex 215 | contains: 216 | Id: 217 | description: Composed node ID 218 | Name: 219 | description: Packages that are installed but at bad versions. 220 | Description: 221 | description: Description associated with the node 222 | UUID: 223 | description: The resource UUID assigned by PODM 224 | PowerState: 225 | description: Current power state 226 | ComposedNodeState: 227 | description: State of the composed node 228 | 229 | sample: 230 | "Id": "Node1" 231 | "Name": "Composed Node" 232 | "Description": "Node #1" 233 | "UUID": "00000000-0000-0000-0000-000000000000" 234 | "PowerState": "On" 235 | "ComposedNodeState": "Allocated" 236 | ''' 237 | 238 | from enum import Enum 239 | from enum import unique 240 | from time import sleep 241 | import os.path 242 | import json 243 | 244 | from ansible.module_utils.rsd_common import RSD 245 | 246 | try: 247 | import rsd_lib 248 | import sushy 249 | import jsonschema 250 | except ImportError: 251 | pass 252 | 253 | 254 | class RsdNodeCompose(RSD): 255 | 256 | @unique 257 | class STATE(Enum): 258 | ABSENT = 'absent' 259 | ALLOCATING = 'allocating' 260 | ALLOCATED = 'allocated' 261 | ASSEMBLING = 'assembling' 262 | ASSEMBLED = 'assembled' 263 | FAILED = 'failed' 264 | 265 | @classmethod 266 | def allowed_module_args(cls): 267 | return ( 268 | cls.ABSENT.value, 269 | cls.ALLOCATED.value, 270 | cls.ASSEMBLED.value 271 | ) 272 | 273 | @classmethod 274 | def allowed_for_deletion(cls): 275 | return ( 276 | cls.ALLOCATED, 277 | cls.ASSEMBLED, 278 | cls.FAILED 279 | ) 280 | 281 | @classmethod 282 | def transition_states(cls): 283 | return ( 284 | cls.ALLOCATING, 285 | cls.ASSEMBLING 286 | ) 287 | 288 | @staticmethod 289 | def of(node): 290 | return RsdNodeCompose.STATE(node.composed_node_state.lower()) 291 | 292 | def __init__(self): 293 | 294 | required_if = [ 295 | ['state', 'absent', ['id']], 296 | ['state', 'allocated', ['spec', 'specfile'], True], 297 | ['state', 'assembled', ['spec', 'specfile', 'id'], True], 298 | ] 299 | 300 | mutually_exclusive = [ 301 | ['id', 'spec', 'specfile'] 302 | ] 303 | 304 | required_one_of = [ 305 | ['id', 'spec', 'specfile'] 306 | ] 307 | 308 | argument_spec = dict( 309 | id=dict( 310 | type='dict', 311 | required=False, 312 | options=dict( 313 | type=dict( 314 | type='str', 315 | required=False, 316 | choices=['name', 'identity', 'uuid'], 317 | default='identity' 318 | ), 319 | value=dict( 320 | type='str', 321 | required=True 322 | ) 323 | ) 324 | ), 325 | spec=dict( 326 | type='dict', 327 | required=False, 328 | options=dict( 329 | name=dict(type='str', required=False), 330 | description=dict(type='str', required=False), 331 | processors=dict(type='json', required=False), 332 | memory=dict(type='json', required=False), 333 | local_drives=dict(type='json', required=False), 334 | remote_drives=dict(type='json', required=False), 335 | eth_ifaces=dict(type='json', required=False), 336 | security=dict(type='dict', required=False), 337 | # oem=dict(type='dict', required=False), 338 | total_cores=dict(type='int', required=False), 339 | total_mem=dict(type='int', required=False), 340 | # performance=() #SupportedPerformanceConfigurations 341 | ), 342 | ), 343 | specfile=dict( 344 | type='path', 345 | aliases=['file'], 346 | required=False 347 | ), 348 | state=dict( 349 | default=self.STATE.ASSEMBLED.value, 350 | choices=self.STATE.allowed_module_args(), 351 | required=False 352 | ), 353 | ) 354 | 355 | super(RsdNodeCompose, self).__init__( 356 | argument_spec, 357 | required_one_of=required_one_of, 358 | required_if=required_if, 359 | mutually_exclusive=mutually_exclusive, 360 | supports_check_mode=False) 361 | 362 | def _wait_for_state_transition(self, node, wait_time=0.5, retries=60): 363 | if not node: 364 | raise ValueError("Cannot wait on node transition without a node") 365 | 366 | while retries > 0: 367 | sleep(wait_time) 368 | 369 | node.refresh() 370 | state = self.STATE.of(node) 371 | 372 | if state in self.STATE.transition_states(): 373 | retries -= 1 374 | else: 375 | break 376 | 377 | return state 378 | 379 | def _delete_node(self, node): 380 | if not node: 381 | # Nothing to delete, no changes 382 | self.module.exit_json(changed=False, msg="Node already absent") 383 | 384 | state = self.STATE.of(node) 385 | 386 | self.module.debug( 387 | "Trying to delete node '{0}' from state '{1}'".format( 388 | node.identity, state.value)) 389 | 390 | if state in self.STATE.transition_states(): 391 | state = self._wait_for_state_transition(node) 392 | 393 | if state in self.STATE.allowed_for_deletion(): 394 | node.delete_node() 395 | self.module.exit_json(changed=True, msg="Node deleted") 396 | else: 397 | self.module.fail_json( 398 | msg="Cannot delete node in '{0}' state".format(state.value)) 399 | 400 | def _parse_node_specfile(self): 401 | podm_file_mappings = [ 402 | ('Name', 'name', False), 403 | ('Description', 'description', False), 404 | ('Processors', 'processor_req', False), 405 | ('Memory', 'memory_req', False), 406 | ('RemoteDrives', 'remote_drive_req', False), 407 | ('LocalDrives', 'local_drive_req', False), 408 | ('EthernetInterfaces', 'ethernet_interface_req', False), 409 | ('Security', 'security_req', False), 410 | # ('OEM', '', False), 411 | ('TotalSystemCoreCount', 'total_system_core_req', False), 412 | ('TotalSystemMemoryMiB', 'total_system_memory_req', False), 413 | # ('SupportedPerformanceConfigurations', '', False) 414 | ] 415 | 416 | filename = self.module.params.get('specfile', None) 417 | if not filename: 418 | return 419 | 420 | if not filename.endswith(".json"): 421 | raise ValueError("File must end with .json extension") 422 | 423 | with open(filename, 'r') as f: 424 | spec = json.load(f) 425 | 426 | return self._translate_request(spec, podm_file_mappings) 427 | 428 | def _parse_node_spec(self): 429 | module_arg_mappings = [ 430 | ('name', 'name', False), 431 | ('description', 'description', False), 432 | ('processors', 'processor_req', True), 433 | ('memory', 'memory_req', True), 434 | ('remote_drives', 'remote_drive_req', True), 435 | ('local_drives', 'local_drive_req', True), 436 | ('eth_ifaces', 'ethernet_interface_req', True), 437 | ('security', 'security_req', False), 438 | # ('oem', '', False), 439 | ('total_cores', 'total_system_core_req', False), 440 | ('total_mem', 'total_system_memory_req', False), 441 | # ('SupportedPerformanceConfigurations', '', True), 442 | ] 443 | 444 | spec = self.module.params.get('spec', None) 445 | return self._translate_request(spec, module_arg_mappings) 446 | 447 | def _translate_request(self, spec, mappings): 448 | if not spec: 449 | raise ValueError("Missing node spec to perform transtation") 450 | 451 | if not isinstance(spec, dict): 452 | raise TypeError("Node specifications must be a dictionary") 453 | 454 | if not mappings: 455 | raise ValueError("Missing node mappings to perform translation") 456 | 457 | to_translate = spec.copy() # no need for a deep copy 458 | translated = dict() 459 | for (podm_opt, lib_opt, decode) in mappings: 460 | value = to_translate.pop(podm_opt, None) 461 | if value: 462 | if decode: 463 | translated[lib_opt] = json.loads(value) 464 | else: 465 | translated[lib_opt] = value 466 | 467 | if to_translate: 468 | self.module.fail_json(msg="Invalid, unsupported or duplicated " 469 | "values in spec: {0}".format(to_translate)) 470 | 471 | self.module.debug("rsd-lib node spec {0}".format(translated)) 472 | 473 | return translated 474 | 475 | def _allocate_node(self): 476 | spec = self._parse_node_specfile() 477 | if not spec: 478 | spec = self._parse_node_spec() 479 | if not spec: 480 | self.module.fail_json(msg="Unable to parse node specs") 481 | 482 | return self._do_allocate_node(spec) 483 | 484 | def _do_allocate_node(self, spec): 485 | nodes = self.rsd.get_node_collection() 486 | try: 487 | node_uri = nodes.compose_node(**spec) 488 | except sushy.exceptions.HTTPError as e: 489 | self.module.fail_json( 490 | msg="Failed to allocate node: {0}".format(str(e))) 491 | except jsonschema.exceptions.ValidationError as e: 492 | self.module.fail_json( 493 | msg="Invalid spec formatting or value: {0}".format(str(e))) 494 | 495 | node_id = os.path.split(node_uri)[-1] 496 | node = self.rsd.get_node(node_uri) 497 | 498 | state = self._wait_for_state_transition(node) 499 | if state is not self.STATE.ALLOCATED: 500 | self.module.fail_json( 501 | msg="Failed to allocate node '{0}'".format(node_id)) 502 | 503 | self.module.debug("Allocated new node with id '{0}'".format(node_id)) 504 | 505 | return node 506 | 507 | def _assemble_node(self, node): 508 | if not node: 509 | raise ValueError("No node provided to assemble") 510 | 511 | state = self.STATE.of(node) 512 | self.module.debug( 513 | "Trying to assemble node '{0}' from state {1}".format( 514 | node.identity, state.value)) 515 | 516 | if state in self.STATE.transition_states(): 517 | state = self._wait_for_state_transition(node) 518 | 519 | if state is self.STATE.ALLOCATED: 520 | self._do_assemble_node(node) 521 | self._return_ok_node_response(node, True) 522 | 523 | elif state is self.STATE.ASSEMBLED: 524 | # Already in the desired state, nothing to do 525 | self._return_ok_node_response(node, False) 526 | 527 | elif state is self.STATE.FAILED: 528 | self.module.fail_json( 529 | msg="Cannot assemble node in 'Failed' state") 530 | 531 | else: 532 | self.module.fail_json( 533 | msg="Cannot assemble node '{0}' from state '{1}'".format( 534 | node.identity, state.value)) 535 | 536 | def _do_assemble_node(self, node): 537 | node.assemble_node() 538 | state = self._wait_for_state_transition(node) 539 | 540 | if state is self.STATE.ASSEMBLED: 541 | self.module.debug( 542 | "Node '{0}' now in Assembled state".format(node.identity)) 543 | 544 | elif state is self.STATE.FAILED: 545 | self.module.fail_json( 546 | msg="Failed to assemble node '{0}'".format(node.identity)) 547 | 548 | else: 549 | self.module.fail_json( 550 | msg="Node '{0}' is in state '{1}', cannot assemble".format( 551 | node.identity, state)) 552 | 553 | def _get_node_links_info(self, node): 554 | info = dict() 555 | system = self.rsd.get_system(node.links.computer_system) 556 | 557 | info["System"] = { 558 | "Name": system.name, 559 | "Description": system.description, 560 | "Id": system.identity, 561 | "ProcessorSummary": { 562 | "Count": system.processor_summary.count, 563 | "Model": system.processor_summary.model 564 | }, 565 | "TotalSystemMemoryGiB": system.memory_summary.total_system_memory_gib 566 | } 567 | 568 | # Waiting for bug fix in rsd-lib 569 | # ifaces = [] 570 | # info["Interfaces"] = ifaces 571 | # iface_ids = node.links.ethernet_interfaces # (tuple of URIs/IDs) 572 | # for iface_id in iface_ids: 573 | # iface = system.ethernet_interfaces.get_member(iface_id) 574 | # ifaces.append({ 575 | # "Name": iface.name, 576 | # "Description": iface.description, 577 | # "Id": iface.identity, 578 | # "MACAddress": iface.mac_address, 579 | # "IPv4Addresses": [a.address for a in iface.ipv4_addresses], 580 | # "IPv6Addresses": [a.address for a in iface.ipv6_addresses], 581 | # }) 582 | 583 | info["Drives"] = dict() 584 | 585 | local_drives = [] 586 | info["Drives"]["Local"] = local_drives 587 | local_drive_ids = node.links.local_drives 588 | for drive_id in local_drive_ids or []: 589 | pass 590 | # drive = system.storage().get_member(drive_id) 591 | # local_drives.append({ 592 | # 593 | # }) 594 | 595 | remote_drives = [] 596 | info["Drives"]["Remote"] = remote_drives 597 | remote_drive_ids = node.links.remote_drives 598 | for drive_id in remote_drive_ids or []: 599 | pass 600 | # drive = rsd.get_storage_service() 601 | return info 602 | 603 | def _return_ok_node_response(self, node, changed): 604 | if not node: 605 | raise ValueError("No node provided to return") 606 | 607 | if not node.uuid: 608 | self.module.fail_json(msg="There is no UUID. Failure.") 609 | 610 | node_desc = dict() 611 | node_desc["Id"] = node.identity 612 | node_desc["Name"] = node.name 613 | node_desc["Description"] = node.description 614 | node_desc["UUID"] = node.uuid 615 | node_desc["ComposedNodeState"] = node.composed_node_state 616 | node_desc["PowerState"] = node.power_state 617 | node_desc["Status"] = { 618 | 'State': node.status.state, 619 | 'Health': node.status.health, 620 | # 'HealthRollup': node.status.health_rollup 621 | } 622 | # node_desc["Boot"] = { 623 | # 'BootSourceOverrideEnabled': node.boot.enabled, 624 | # 'BootSourceOverrideMode': node.boot.mode, 625 | # 'BootSourceOverrideTarget': node.boot.target 626 | # } 627 | node_desc['Details'] = self._get_node_links_info(node) 628 | 629 | self.module.exit_json(changed=changed, node=node_desc) 630 | 631 | ############################################################################### 632 | 633 | def _delete_existing_node(self): 634 | self.module.debug("Request to delete an existing node") 635 | 636 | node = self._get_node() 637 | self._delete_node(node) 638 | 639 | def _assemble_allocated_node(self): 640 | self.module.debug("Request to assemble an existing node") 641 | 642 | node = self._get_node() 643 | self._assemble_node(node) 644 | 645 | def _allocate_new_node(self): 646 | self.module.debug("Request to allocate a new node") 647 | 648 | node = self._allocate_node() 649 | self._return_ok_node_response(node, True) 650 | 651 | def _allocate_and_assemble_new_node(self): 652 | self.module.debug("Request to assemble a new node") 653 | 654 | node = self._allocate_node() 655 | self._assemble_node(node) 656 | 657 | def run(self): 658 | id = self.module.params.get('id', None) 659 | requested_state = self.STATE(self.module.params['state']) 660 | 661 | if id and requested_state is self.STATE.ABSENT: 662 | self._delete_existing_node() 663 | 664 | elif id and requested_state is self.STATE.ASSEMBLED: 665 | self._assemble_allocated_node() 666 | 667 | elif requested_state is self.STATE.ALLOCATED: 668 | self._allocate_new_node() 669 | 670 | elif requested_state is self.STATE.ASSEMBLED: 671 | self._allocate_and_assemble_new_node() 672 | 673 | else: 674 | self.module.fail_json(msg="Invalid options for the module") 675 | 676 | 677 | def main(): 678 | compose = RsdNodeCompose() 679 | compose.run() 680 | 681 | 682 | if __name__ == '__main__': 683 | main() 684 | -------------------------------------------------------------------------------- /library/LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /module_utils/LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------