{"id":14069672,"url":"https://github.com/GoogleCloudPlatform/google-cloud-ops-agents-puppet","last_synced_at":"2025-07-30T06:32:22.169Z","repository":{"id":48360769,"uuid":"106311466","full_name":"GoogleCloudPlatform/google-cloud-ops-agents-puppet","owner":"GoogleCloudPlatform","description":"Managed Google Stackdriver Logging Agent via Puppet","archived":false,"fork":false,"pushed_at":"2025-03-26T22:20:48.000Z","size":54,"stargazers_count":5,"open_issues_count":14,"forks_count":11,"subscribers_count":43,"default_branch":"master","last_synced_at":"2025-06-24T09:06:43.041Z","etag":null,"topics":["google","google-gcompute","puppet","stackdriver","stackdriver-agent","stackdriver-logs","stackdriver-monitoring"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GoogleCloudPlatform.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-10-09T17:04:48.000Z","updated_at":"2024-03-12T12:42:26.000Z","dependencies_parsed_at":"2024-11-16T17:30:05.572Z","dependency_job_id":"3abdc67e-fe74-4aa8-b068-491bd5492d06","html_url":"https://github.com/GoogleCloudPlatform/google-cloud-ops-agents-puppet","commit_stats":{"total_commits":8,"total_committers":6,"mean_commits":"1.3333333333333333","dds":0.625,"last_synced_commit":"70b2b3aa198e2286a56bfa70eed268d81034af60"},"previous_names":["googlecloudplatform/puppet-google-logging"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/GoogleCloudPlatform/google-cloud-ops-agents-puppet","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GoogleCloudPlatform%2Fgoogle-cloud-ops-agents-puppet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GoogleCloudPlatform%2Fgoogle-cloud-ops-agents-puppet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GoogleCloudPlatform%2Fgoogle-cloud-ops-agents-puppet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GoogleCloudPlatform%2Fgoogle-cloud-ops-agents-puppet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GoogleCloudPlatform","download_url":"https://codeload.github.com/GoogleCloudPlatform/google-cloud-ops-agents-puppet/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GoogleCloudPlatform%2Fgoogle-cloud-ops-agents-puppet/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266846215,"owners_count":23994258,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-24T02:00:09.469Z","response_time":99,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["google","google-gcompute","puppet","stackdriver","stackdriver-agent","stackdriver-logs","stackdriver-monitoring"],"created_at":"2024-08-13T07:07:07.809Z","updated_at":"2025-07-30T06:32:21.854Z","avatar_url":"https://github.com/GoogleCloudPlatform.png","language":"Shell","readme":"# Google Cloud Operations Agents Puppet Integration\n\n[![Status](https://github.com/GoogleCloudPlatform/google-cloud-ops-agents-puppet/workflows/linux/badge.svg)](https://github.com/GoogleCloudPlatform/google-cloud-ops-agents-puppet/linux)\n[![Status](https://github.com/GoogleCloudPlatform/google-cloud-ops-agents-puppet/workflows/windows/badge.svg)](https://github.com/GoogleCloudPlatform/google-cloud-ops-agents-puppet/windows)\n[![Status](https://github.com/GoogleCloudPlatform/google-cloud-ops-agents-puppet/workflows/shellcheck/badge.svg)](https://github.com/GoogleCloudPlatform/google-cloud-ops-agents-puppet/shellcheck)\n\n## Description\n\nPuppet module for [Google Cloud Operations agents](https://cloud.google.com/stackdriver/docs/solutions/agents).\n\n## Support Matrix\n\n- Linux\n  - [Ops Agent](https://cloud.google.com/stackdriver/docs/solutions/agents/ops-agent)\n    - [Supported operating systems](https://cloud.google.com/stackdriver/docs/solutions/agents/ops-agent#supported_operating_systems)\n  - [Monitoring Agent](https://cloud.google.com/stackdriver/docs/solutions/agents/monitoring)\n    - [Supported Operating Systems](https://cloud.google.com/stackdriver/docs/solutions/agents/monitoring#supported_operating_systems)\n  - [Logging Agent](https://cloud.google.com/stackdriver/docs/solutions/agents/logging)\n    - [Supported Operating Systems](https://cloud.google.com/stackdriver/docs/solutions/agents/logging#supported_operating_systems)\n- Windows\n  - [Cloud Ops Agent](https://cloud.google.com/stackdriver/docs/solutions/agents/ops-agent)\n    - [Supported Operating Systems](https://cloud.google.com/stackdriver/docs/solutions/agents/ops-agent#supported_operating_systems)\n\n## Requirements\n\nhttps://cloud.google.com/stackdriver/docs/solutions/agents/ops-agent#access\n\n## Prerequisite Modules\n\nThe following modules must be available on the Puppet server:\n- [lwf-remote_file](https://forge.puppet.com/modules/lwf/remote_file)\n\n## Install Module\n\n### Install Module from Source\nTo build the module from source:\n- Build: `pdk build`\n- Copy to your Puppet server\n  - The built module can be found in `pkg/`\n- Install: `puppet module install ops-cloud_ops-0.1.0.tar.gz`\n- Verify: `puppet module list`\n\n## Usage\n\n| Parameter               | Default       | Description                                                       |\n| ---                     | ---           | ---                                                               |\n| `agent_type`            | Required      | The agent type. The allowed values are: `ops-agent`, `monitoring`, `logging`              |\n| `package_state`         | `present`     | Whether the agent should be installed or not. The allowed values are: `present` and `absent`. |\n| `version`               | `latest`      | The version variable can be used to specify which version of the agent to install. The allowed values are `latest`, `MAJOR_VERSION.*.*` and `MAJOR_VERSION.MINOR_VERSION.PATCH_VERSION`, which are described in detail below. |\n| `main_config`           |               | Optional value for overriding the default configuration. For configuration syntax instructions, see [Ops Agent Config](https://cloud.google.com/stackdriver/docs/solutions/agents/ops-agent/configuration), [Logging Agent Config](https://cloud.google.com/logging/docs/agent/logging/configuration), and [Monitoring Agent](https://cloud.google.com/monitoring/agent/monitoring/configuration) for more details.           |\n| `additional_config_dir` |               | Optional value for overriding the plugins directory for the `monitoring` or `logging` agents |\n\n### Version\n\n- version=`latest`\n  - This setting makes it easier to keep the agent version up to date, however it does come with a potential risk. When a new major version is released, the policy may install the latest version of the agent from the new major release, which may introduce breaking changes. For production environments, consider using the version=MAJOR_VERSION.*.* setting below for safer agent deployments.\n\n- version=`MAJOR_VERSION.*.*`\n  - When a new major release is out, this setting ensures that only the latest version from the specified major version is installed, which avoids accidentally introducing breaking changes. This is recommended for production environments to ensure safer agent deployments.\n\n- version=`MAJOR_VERSION.MINOR_VERSION.PATCH_VERSION`\n  - This setting is not recommended since it prevents upgrades of new versions of the agent that include bug fixes and other improvements.\n\n### Example:\n\nAn example implementation can be found in [test/cases/linux/ops-agent/latest/install/manifests/site.pp](test/cases/linux/ops-agent/latest/install/manifests/site.pp)\n\n#### Ops Agent\n\nInstall the latest version:\n```ruby\ngoogle_cloud_ops::agent {'ops-agent':\n  agent_type  =\u003e 'ops-agent',\n}\n```\n\n#### Ops Agent with Custom Configuration\n\nThis example assumes:\n- The module's name is `example`\n- The module `example` has a file at `files/ops_agent/config.yaml` that represents the custom configuration\n\nInstall version 1.0.5 and use a custom configuration:\n```ruby\ngoogle_cloud_ops::agent {'ops-agent':\n  agent_type  =\u003e 'ops-agent',\n  installed   =\u003e true,\n  version     =\u003e '1.0.5',\n  main_config =\u003e 'puppet:///modules/example/ops_agent/config.yaml',\n}\n```\n\n#### Remove Ops Agent\n\nEnsure the agent is not installed by setting `installed` to false:\n```ruby\ngoogle_cloud_ops::agent {'ops-agent':\n  agent_type  =\u003e 'ops-agent',\n  installed   =\u003e false,\n  version     =\u003e 'latest',\n}\n```\n\n#### Install Monitoring Agent\n\n- Install latest release of major version 6\n- Use custom configuration\n- Use custom plugins\n\n```ruby\ngoogle_cloud_ops::agent {'monitoring-agent':\n  agent_type            =\u003e 'monitoring',\n  installed             =\u003e true,\n  version               =\u003e '6.*.*',\n\n  # optional\n  main_config           =\u003e 'puppet:///modules/example/monitoring/collectd.conf',\n  additional_config_dir =\u003e 'puppet:///modules/example/monitoring/plugins'\n}\n```\n\n#### Install Logging Agent\n\n- Install latest release\n- Use custom configuration\n- Use custom plugins\n\n```ruby\ngoogle_cloud_ops::agent {'logging-agent':\n  agent_type            =\u003e 'logging',\n  installed             =\u003e true,\n  version               =\u003e 'latest',\n\n  # optional\n  main_config           =\u003e 'puppet:///modules/example/logging/google-fluentd.conf',\n  additional_config_dir =\u003e 'puppet:///modules/example/logging/plugins'\n}\n```\n\n## License\n\n```\nCopyright 2021 Google Inc. All rights reserved.\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use\nthis file except in compliance with the License.  You may obtain a copy of the\nLicense at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed\nunder the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR\nCONDITIONS OF ANY KIND, either express or implied.  See the License for the\nspecific language governing permissions and limitations under the License.\n```\n","funding_links":[],"categories":["Shell"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FGoogleCloudPlatform%2Fgoogle-cloud-ops-agents-puppet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FGoogleCloudPlatform%2Fgoogle-cloud-ops-agents-puppet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FGoogleCloudPlatform%2Fgoogle-cloud-ops-agents-puppet/lists"}