Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Support Windows #2

Closed
wants to merge 33 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
045eec8
initial port from observiq agent role
jsirianni Jul 11, 2023
7ec0d84
add install_dir var
jsirianni Jul 11, 2023
5cb1a78
fix notify handler
jsirianni Jul 11, 2023
583bd34
fix notify handler
jsirianni Jul 11, 2023
ba83011
update example and cleanup config
jsirianni Jul 11, 2023
21efb1b
fix insecure verify default value
jsirianni Jul 11, 2023
88f5262
fix config handler
jsirianni Jul 11, 2023
d9a9606
use conditionals for tls options
jsirianni Jul 11, 2023
1970611
manage manager.yaml directly
jsirianni Jul 11, 2023
90e1887
try using null for default values
jsirianni Jul 11, 2023
af90410
use environment w/ systemd override for initial opamp config
jsirianni Jul 11, 2023
2687841
Add testing framework
jsirianni Jul 11, 2023
fab36d0
add codeowners, dependabot, ci
jsirianni Jul 11, 2023
ea9476f
uncomment pyenv
jsirianni Jul 11, 2023
0f74fa0
update batch
jsirianni Jul 11, 2023
0122109
Wording
jsirianni Jul 11, 2023
d43bace
update secret names and setup concurrency
jsirianni Jul 11, 2023
942317f
use preemptible: true
jsirianni Jul 11, 2023
434fe06
use latest gce driver and try newer python version
jsirianni Jul 11, 2023
5f31e19
fix linter issue
jsirianni Jul 11, 2023
ab2b412
remove lint command in favor of syntax
jsirianni Jul 11, 2023
fdc2c55
retry google auth
jsirianni Jul 11, 2023
5060836
prevent workflow cancel
jsirianni Jul 11, 2023
06642e6
add dedicated create step
jsirianni Jul 12, 2023
920007e
add project flag
jsirianni Jul 12, 2023
f0ee584
let converge handle create
jsirianni Jul 12, 2023
b52048d
add configuration label example
jsirianni Jul 12, 2023
6335ecd
remove ignore [skip-ci]
jsirianni Jul 12, 2023
71264c9
switch back to deploying manager.yaml but avoid updating it
jsirianni Jul 20, 2023
207031a
remove unused vars. add manager_path var. update service handler name…
jsirianni Jul 20, 2023
6d0f51e
wip: windows progress
jsirianni Jul 20, 2023
bd5d077
wip
jsirianni Jul 20, 2023
ee8ee6d
finish windows
jsirianni Jul 20, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @observIQ/platform
6 changes: 6 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
version: 2
updates:
- package-ecosystem: "pip"
directory: "/"
schedule:
interval: "monthly"
96 changes: 96 additions & 0 deletions .github/workflows/integration.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
name: Integration Tests
on:
pull_request:
push:
branches:
- main

concurrency:
group: ${{ github.head_ref || github.ref_name }}
# Avoid canceling to allow compute instances to be deleted
# by the "Cleanup test instances" step.
cancel-in-progress: false

env:
GCP_PROJECT_ID: ${{secrets.GCP_PROJECT_ID}}
OPAMP_SECRET_KEY: ${{secrets.OPAMP_SECRET_KEY}}
SSH_KEY_FILE: id_rsa
SSH_USER: ${{secrets.SSH_USER}}
GCP_AUTH_KIND: serviceaccount

jobs:
integration:
name: Molecule
runs-on: ubuntu-20.04
strategy:
fail-fast: false
matrix:
scenario:
# scenario names are derived from molecule scenarios
# at molecule/
- "default"
steps:
- name: Checkout the codebase.
uses: actions/checkout@v2

- name: Install Gcloud SDK
uses: google-github-actions/[email protected]

- name: Authenticate to Google Cloud
uses: google-github-actions/[email protected]
with:
credentials_json: ${{ secrets.GCP_SA_KEY }}
# when true, GOOGLE_APPLICATION_CREDENTIALS is set.
create_credentials_file: true

- name: Deploy SSH Keypair
run: |
echo "$SSH_PRIVATE_KEY" > id_rsa
echo "$SSH_PUBLIC_KEY" > id_rsa.pub
chmod -R 0600 id_rsa
chmod -R 0600 id_rsa.pub
shell: bash
env:
SSH_PRIVATE_KEY: ${{secrets.SSH_PRIVATE_KEY}}
SSH_PUBLIC_KEY: ${{secrets.SSH_PUBLIC_KEY}}

- name: Set up Python 3.
uses: actions/setup-python@v2
with:
python-version: '3.10'

# https://github.com/actions/cache/blob/main/examples.md#python---pip
- name: Cache Pip modules
uses: actions/cache@v2
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-

- name: Install Pip Modules.
run: |
pip3 install -r requirements.txt
echo "${HOME}/.local/bin" >> $GITHUB_PATH

- name: Install Galaxy Modules
run: |
ansible-galaxy collection install google.cloud
ansible-galaxy collection install community.crypto

- name: Lint.
run: |
molecule syntax -s ${{ matrix.scenario }}

- name: Converge.
run: molecule converge -s ${{ matrix.scenario }}

- name: Check Idempotence.
run: molecule idempotence -s ${{ matrix.scenario }}

- name: Verify.
run: molecule verify -s ${{ matrix.scenario }}

- name: Cleanup test instances.
run: molecule destroy -s ${{ matrix.scenario }}
if: ${{ always() }}
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
site.yml
playbook.yml
*.json
.env
gcp_sa_key.json
ssh-key-ansible-sa
ssh-key-ansible-sa.pub
test/
202 changes: 202 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright observIQ, Inc, Google, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,35 @@
Ansible Role For [BindPlane Agent](https://github.com/observIQ/observiq-otel-collector)
==========================

[![Integration Tests](https://github.com/observIQ/bindplane-agent-ansible/actions/workflows/integration.yml/badge.svg)](https://github.com/observIQ/bindplane-agent-ansible/actions/workflows/integration.yml)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

Install the role in your roles path (usually in a `roles` directory
alongside your playbook) under the name `bindplane_agent`:

```bash
git clone https://github.com/observIQ/bindplane-agent-ansible.git roles/bindplane_agent
```

Role Variables
--------------

| Name | Default Value | Description |
| -------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------ |
| `version` | required | The `version` is required to specify which version of the agent to install. Supported versions: `1.28.0` or newer. |
| `endpoint` | required | Endpoint for the BindPlane OP server's OpAMP interface. |
| `secret_key` | required | The BindPlane OP secret key. |
| `labels` | optional | Labels assigned to the agent. |
| `ca_file` | optional | Path to x509 PEM encoded CA certificate, used to trust the BindPlane OP's certificate. |
| `cert_file` | optional | Path to x509 PEM encoded certificate file path, used for mutual TLS authentication. |
| `key_file` | optional | Path to x509 PEM encoded private key file path, used for mutual TLS authentication. |
| `insecure_skip_verify` | optional | Whether or not to skip verification of TLS certificates. |

## Documentation

- [Usage](./docs/USAGE.md)
- [Developing](./docs/DEVELOPING.md)

## License

This library is licensed under Apache 2.0. Full license text is available in [LICENSE](LICENSE).
12 changes: 12 additions & 0 deletions defaults/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
# Variables that can be empty
labels: ""
cert_file: ""
key_file: ""
ca_file: ""
insecure_skip_verify: false

package_type: "{{ 'rpm' if ansible_os_family in ['RedHat', 'Suse'] else 'deb' }}"
arch: "{{ 'arm64' if ansible_architecture in ['arm64', 'aarch64'] else 'amd64' }}"
linux_package_url: "https://github.com/observIQ/observiq-otel-collector/releases/download/v{{ version }}/observiq-otel-collector_v{{ version }}_linux_{{ arch }}.{{ package_type }}"
windows_package_url: "https://github.com/observIQ/observiq-otel-collector/releases/download/v{{ version }}/observiq-otel-collector.msi"
Loading
Loading