Files
confdroid_java/README.md

89 lines
3.1 KiB
Markdown
Raw Permalink Normal View History

2025-05-05 15:51:43 +02:00
# Readme
2025-05-05 13:36:21 +00:00
2026-04-16 14:59:05 +02:00
[![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_java&style=plastic)](https://jenkins.confdroid.com/job/confdroid_java/)
2026-04-16 21:57:39 +02:00
[![Security Hotspots](https://sonarqube.confdroid.com/api/project_badges/measure?project=confdroid_java&metric=security_hotspots&token=sqb_c7b9021dbe66678773699d0232454ad6cc64234f)](https://sonarqube.confdroid.com/dashboard?id=confdroid_java)
2026-04-16 14:59:05 +02:00
- [Readme](#readme)
- [Synopsis](#synopsis)
- [WARNING](#warning)
- [Features](#features)
- [Repo Documentation](#repo-documentation)
- [Dependencies](#dependencies)
- [Deployment](#deployment)
- [SELINUX](#selinux)
- [Known Problems](#known-problems)
- [Support](#support)
- [Tests](#tests)
- [Contact Us](#contact-us)
- [Disclaimer](#disclaimer)
2025-05-05 13:36:21 +00:00
2025-05-05 15:51:43 +02:00
## Synopsis
2025-05-05 13:36:21 +00:00
2026-04-18 17:41:50 +02:00
`confdroid_java` is a Puppet module to automate installation and configuration of java, mainly to install the binaries and main configuration files for use with other modules, like [confdroid_jenkins](https://sourcecode.confdroid.com/confdroid/confdroid_jenkins).
2025-05-05 13:36:21 +00:00
2025-05-05 15:51:43 +02:00
## WARNING
2025-05-05 13:36:21 +00:00
2026-04-16 22:03:53 +02:00
> **Attention: Never use this puppet module on systems which have been previously configured manually. It is impossible to predict how and what would have been configured, hence previous configurations outside the scope of this module may be overwritten! Automated configurations require a test environment to verify that the module suits the purpose intended by the user, as well as tune the parameters, before deploying into live production**
2025-05-05 13:36:21 +00:00
2025-05-05 15:51:43 +02:00
## Features
2025-05-05 13:36:21 +00:00
2025-05-05 15:51:43 +02:00
INSTALLATION
2025-05-05 13:36:21 +00:00
2026-04-16 14:59:05 +02:00
- installs java binaries as specified.
2025-05-05 13:36:21 +00:00
2025-05-05 15:51:43 +02:00
## Repo Documentation
2025-05-05 13:36:21 +00:00
2025-05-05 15:51:43 +02:00
See the full Puppet documentation including parameters in `docs/index.html`
2025-05-05 13:36:21 +00:00
2025-05-05 15:51:43 +02:00
## Dependencies
2025-05-05 13:36:21 +00:00
2025-05-05 15:51:43 +02:00
All dependencies must be included in the catalogue.
2025-05-05 13:36:21 +00:00
2025-05-05 15:51:43 +02:00
## Deployment
2025-05-05 13:36:21 +00:00
2026-04-16 14:59:05 +02:00
- native Puppet deployment
2025-05-05 13:36:21 +00:00
2025-05-05 15:51:43 +02:00
via site.pp or nodes.pp
2025-05-05 13:36:21 +00:00
2025-05-05 15:51:43 +02:00
```bash
node 'example.example.net' {
2026-04-16 14:59:05 +02:00
include confdroid_java
2025-05-05 15:51:43 +02:00
}
```
2025-05-05 13:36:21 +00:00
2026-04-16 14:59:05 +02:00
- through Foreman:
2025-05-05 13:36:21 +00:00
2025-05-05 15:51:43 +02:00
In order to apply parameters through Foreman, the params.pp must be added to the host or host group in question.
2025-05-05 13:36:21 +00:00
2025-05-05 15:51:43 +02:00
See [more details about class deployment on Confdroid.com](https://confdroid.com/2017/05/deploying-our-puppet-modules/).
2025-05-05 13:36:21 +00:00
2025-05-05 15:51:43 +02:00
## SELINUX
2025-05-05 13:36:21 +00:00
2025-05-05 15:51:43 +02:00
All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored.
2025-05-05 13:36:21 +00:00
2025-05-05 15:51:43 +02:00
## Known Problems
2025-05-05 13:36:21 +00:00
## Support
2026-04-16 14:59:05 +02:00
- OS: Rocky 9 (all RHEL-based OS should work but Rocky 9 is tested)
- Puppet 8
2025-05-05 13:36:21 +00:00
2025-05-05 15:51:43 +02:00
## Tests
2025-05-05 13:36:21 +00:00
2026-04-16 14:59:05 +02:00
- Puppet Lint
- excluded tests:
- `--no-variable_scope-check`: not applicable as we are inheriting parameters from params class. the lint check does not distinguish between facts and inherited parameters.
- Puppet Parser
- ERB Template Parser
- Sonar Quality Gate
2025-05-05 13:36:21 +00:00
2025-05-05 15:51:43 +02:00
## Contact Us
2025-05-05 13:36:21 +00:00
2026-04-16 14:59:05 +02:00
- [contact Us](https://confdroid.com/contact/)
- [Feedback Portal](https://feedback.confdroid.com/)
2025-05-05 13:36:21 +00:00
2025-05-05 15:51:43 +02:00
## Disclaimer
2025-05-05 13:36:21 +00:00
2025-05-05 15:51:43 +02:00
ConfDroid as entity is entirely independent from Puppet. We provide custom configuration modules, written for specific purposes and specific environments.
The modules are tested and supported only as documented, and require testing in designated environments (i.e. lab or development environments) for parameter tuning etc. before deploying into production environments.