https://github.com/saltstack-formulas/java-formula
https://github.com/saltstack-formulas/java-formula
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/saltstack-formulas/java-formula
- Owner: saltstack-formulas
- License: other
- Created: 2013-06-12T22:13:40.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2025-01-06T23:08:42.000Z (about 1 year ago)
- Last Synced: 2025-01-07T00:24:58.484Z (about 1 year ago)
- Language: Jinja
- Homepage: http://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html
- Size: 378 KB
- Stars: 11
- Watchers: 35
- Forks: 30
- Open Issues: 3
-
Metadata Files:
- Readme: docs/README.rst
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS
- Authors: AUTHORS.md
Awesome Lists containing this project
README
java-formula
============
|img_travis| |img_sr|
.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/java-formula.svg?branch=master
:alt: Travis CI Build Status
:scale: 100%
:target: https://travis-ci.com/saltstack-formulas/java-formula
.. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
:alt: Semantic Release
:scale: 100%
:target: https://github.com/semantic-release/semantic-release
Formula to install Java on GNU/Linux and MacOS, supporting multiple JDK/JRE providers (default is AdoptOpenJK):
- AdoptOpenJDK
- Amazon Corretto
- Graalvm
- Haikuvm
- IntelliJ
- Oracle
- Zulu
.. contents:: **Table of Contents**
:depth: 1
General notes
-------------
See the full `SaltStack Formulas installation and usage instructions
`_.
If you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section
`_.
If you want to use this formula, please pay attention to the ``FORMULA`` file and/or ``git tag``,
which contains the currently released version. This formula is versioned according to `Semantic Versioning `_.
See `Formula Versioning Section `_ for more details.
If you need (non-default) configuration, please refer to:
- `how to configure the formula with map.jinja `_
- the ``pillar.example`` file
- the `Special notes`_ section
Contributing to this repo
-------------------------
**Commit message formatting is significant!!**
Please see `How to contribute `_ for more details.
Special notes
-------------
Set `java.provider = adopt|amazon|graalvm|haikuvm|intellij|oracle|zulu` pillar to change jdk provider.
Available states
----------------
.. contents::
:local:
``java``
^^^^^^^^
*Meta-state (This is a state that includes other states)*.
This installs Java package,
manages Java configuration file and then
configures the development environment.
``java.archive``
^^^^^^^^^^^^^^^^
This state will install Java from archive only.
``java.macapp``
^^^^^^^^^^^^^^^
This state will install Java macpackage on MacOS only, if supplied by provider.
``java.package``
^^^^^^^^^^^^^^^^
This state installs default Java package supplied by OS if applicable (not recommended).
``java.config``
^^^^^^^^^^^^^^^
This state will configure java and/or environment and has a dependency on ``java.install``
via include list.
``java.config.linuxenv``
^^^^^^^^^^^^^^^^^^^^^^^^
This state will setup Java linux-alternatives on GNU/Linux.
``java.clean``
^^^^^^^^^^^^^^
*Meta-state (This is a state that includes other states)*.
this state will undo everything performed in the ``java`` meta-state in reverse order, i.e.
removes the configuration file and
then uninstalls the package.
``java.config.clean``
^^^^^^^^^^^^^^^^^^^^^
This state will remove the configuration of Java and has a
dependency on ``java.package.clean`` via include list.
``java.archive.clean``
^^^^^^^^^^^^^^^^^^^^^^
This state will remove Java package and has a dependency on
``java.config.clean`` via include list.
``java.macapp.clean``
^^^^^^^^^^^^^^^^^^^^^
This state will remove Java mapackage and has a dependency on
``java.config.clean`` via include list.
``java.config.linuxenv.clean``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This state will remove Java linux-alternatives on GNU/Linux.
Testing
-------
Linux testing is done with ``kitchen-salt``.
Requirements
^^^^^^^^^^^^
* Ruby
* Docker
.. code-block:: bash
$ gem install bundler
$ bundle install
$ bin/kitchen test [platform]
Where ``[platform]`` is the platform name defined in ``kitchen.yml``,
e.g. ``debian-9-2019-2-py3``.
``bin/kitchen converge``
^^^^^^^^^^^^^^^^^^^^^^^^
Creates the docker instance and runs the ``java`` main state, ready for testing.
``bin/kitchen verify``
^^^^^^^^^^^^^^^^^^^^^^
Runs the ``inspec`` tests on the actual instance.
``bin/kitchen destroy``
^^^^^^^^^^^^^^^^^^^^^^^
Removes the docker instance.
``bin/kitchen test``
^^^^^^^^^^^^^^^^^^^^
Runs all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``verify`` + ``destroy``.
``bin/kitchen login``
^^^^^^^^^^^^^^^^^^^^^
Gives you SSH access to the instance for manual testing.