Name: ci.chef.wlp
Owner: WASdev
Description: Chef cookbook for installing and managing WebSphere Application Server Liberty Profile #devops
Created: 2013-07-10 08:20:14.0
Updated: 2017-11-23 14:14:03.0
Pushed: 2016-02-17 14:41:04.0
Size: 194
Language: Ruby
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
The wlp cookbook installs and configures the WebSphere Application Server Liberty Profile. It provides recipes, resources, and libraries for creating, managing, and configuring Liberty profile server instances.
The wlp cookbook can install the Liberty profile from jar archive files or a zip file. The installation method is configured via the node[:wlp][:install_method]
attribute.
The node[:wlp][:archive][:version_yaml]
attribute provides the location of a Yaml file which lists the URLs of the jar archive file for the latest release and latest beta. By default the latest release is installed. To install the latest beta, set the node[:wlp][:archive][:use_beta]
attribute to true
.
The node[:wlp][:archive][:runtime][:url]
attribute, when set, overrides the location from the Yaml file. Setting it also causes the node[:wlp][:archive][:extended][:url]
and node[:wlp][:archive][:extras][:url]
to be used.
For more information on these options, see the attributes section later in this readme. You must also set the node[:wlp][:archive][:accept_license]
attribute to true
if you agree and accept the license terms of the Liberty profile software. The jar installation fails if node[:wlp][:archive][:accept_license]
is not set to true
.
By default the cookbook is configured to use the jar installation method. The archive options are already configured with values based on developer licensed Liberty profile.
The no-fee developer licensed Liberty profile jar archive files can be downloaded from Liberty download page on WASdev site. The production licensed Liberty profile jar archive files can be obtained from IBM Passport Advantage.
When the zip installation method is used, only the node[:wlp][:zip][:url]
attribute must be set to specify the location of the zip file. The zip file is assumed to be generated by running the ./bin/server package
Liberty command with the --include=all
or --include=minify
option.
node[:wlp][:user]
- User name under which the server is installed and runs. Defaults to wlp
.node[:wlp][:group]
- Group name under which the server is installed and runs. Defaults to wlpadmin
.node[:wlp][:install_java]
- Use the java
cookbook to install Java. If Java is installed using a
different method override it to false
, in which case, the Java executables
must be available on the PATH. Defaults to true
.node[:wlp][:base_dir]
- Base installation directory. Defaults to /opt/was/liberty
.node[:wlp][:user_dir]
- User directory (wlp.user.dir). Set to 'nil' to use default location. Defaults to nil
.node[:wlp][:install_method]
- Installation method. Set it to 'archive' or 'zip'. Defaults to archive
.node[:wlp][:archive][:version_yaml]
- Location of the Yaml file containing the URLs of the 'archive' install file
for the latest release and latest beta. Defaults to http://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/wasdev/downloads/wlp/index.yml
.node[:wlp][:archive][:use_beta]
- Use the beta instead of the release. Defaults to false
.node[:wlp][:archive][:runtime][:url]
- URL location of the runtime archive. Overrides the location in the Yaml file. Defaults to nil
.node[:wlp][:archive][:extended][:url]
- URL location of the extended archive. Only used if the archive runtime url
is set. Defaults to nil
.node[:wlp][:archive][:extras][:url]
- URL location of the extras archive. Only used if
node[:wlp][:archive][:runtime][:url]
is set. Defaults to nil
.node[:wlp][:archive][:extended][:install]
- Controls whether the extended archive is downloaded and installed. Defaults to true
.node[:wlp][:archive][:extras][:install]
- Controls whether the extras archive is downloaded and installed. Defaults to false
.node[:wlp][:archive][:extras][:base_dir]
- Base installation directory of the extras archive. Defaults to #{node[:wlp][:base_dir]}/extras
.node[:wlp][:archive][:accept_license]
- Accept license terms when doing archive-based installation.
Must be set to true
or the installation fails. Defaults to false
.node[:wlp][:zip][:url]
- URL location for a zip file containing Liberty profile installation files.
Must be set if node[:wlp][:install_method]
is set to zip
. Defaults to nil
.node[:wlp][:repository][:liberty]
- Controls whether install_feature and download_feature uses the online liberty repository. Defaults to true
.node[:wlp][:repository][:urls]
- Sets a list of URLs for hosted or local asset repository used by install_feature and download_feature. Defaults to [ ... ]
.node[:wlp][:config][:basic]
- Defines a basic server configuration when creating server instances using
the wlp_server
resource. Defaults to { ... }
.node[:wlp][:servers][:defaultServer]
- Defines a defaultServer
server instance. Used by the serverconfig
recipe. Defaults to { ... }
.node[:wlp][:servers][<server_name>]
definition.Installs WebSphere Application Server Liberty Profile. Liberty profile can be
installed using jar archive files, or from a zip file based on the node[:wlp][:install_method]
setting.
Creates a Liberty profile server instance for each node[:wlp][:servers][<server_name>]
definition.
The following definition creates a simple airport
server instance:
[:wlp][:servers][:airport] = {
nabled" => true,
escription" => "Airport Demo App",
eatureManager" => {
"feature" => [ "jsp-2.2" ]
ttpEndpoint" => {
"id" => "defaultHttpEndpoint",
"host" => "*",
"httpPort" => "9080",
"httpsPort" => "9443"
Adds, removes, and sets bootstrap properties for a particular server instance.
nil
.nil
.bootstrap_properties "add to bootstrap.properties" do
rver_name "myInstance"
operties "com.ibm.ws.logging.trace.file.name" => "trace.log"
tion :add
bootstrap_properties "remove from bootstrap.properties" do
rver_name "myInstance"
operties [ "com.ibm.ws.logging.trace.file.name" ]
tion :remove
bootstrap_properties "set bootstrap.properties" do
operties "default.http.port" => "9081", "default.https.port" => "9444"
tion :set
Provides operations for creating, joining, replicating, and removing Liberty profile servers from a collective.
nil
.nil
.nil
.nil
.nil
.nil
.nil
. me in!
Generates a server.xml file from a hash expression.
nil
.nil
.config "/var/servers/airport/server.xml" do
nfig ({
"description" => "Airport Demo App",
"featureManager" => {
"feature" => [ "jsp-2.2" ]
},
"httpEndpoint" => {
"id" => "defaultHttpEndpoint",
"host" => "*",
"httpPort" => "9080",
"httpsPort" => "9443"
}
Downloads an asset from the Liberty Repository or a local LARS repository.
nil
.nil
.false
.download_feature "mongodb" do
me "mongodb-2.0"
rectory "/opt/ibm/wlp/features"
cept_license true
Installs an asset from the Liberty Repository, a local LARS repository, or a local directory based repository.
nil
.“usr”
.false
.install_feature "mongodb" do
me "mongodb-2.0"
cept_license true
Adds, removes, and sets JVM options in an installation-wide or instance-specific jvm.options file.
nil
.nil
.jvm_options "add to instance-specific jvm.options" do
rver_name "myInstance"
tions [ "-Djava.net.ipv4=true" ]
tion :add
jvm_options "remove from instance-specific jvm.options" do
rver_name "myInstance"
tions [ "-Djava.net.ipv4=true" ]
tion :remove
jvm_options "add to installation-wide jvm.options" do
tions [ "-Xmx1024m" ]
tion :add
jvm_options "remove from installation-wide jvm.options" do
tions [ "-Xmx1024m" ]
tion :remove
Provides operations for creating, starting, stopping, and destroying Liberty profile server instances.
node[:wlp][:config][:basic]
is used as the initial configuration. Defaults to nil
.[]
.{}
.{}
.false
.false
.server "myInstance" do
nfig ({
"featureManager" => {
"feature" => [ "jsp-2.2", "jaxws-2.1" ]
},
"httpEndpoint" => {
"id" => "defaultHttpEndpoint",
"host" => "*",
"httpPort" => "9080",
"httpsPort" => "9443"
},
"application" => {
"id" => "example",
"name" => "example",
"type" => "war",
"location" => "/apps/example.war"
}
})
mOptions [ "-Djava.net.ipv4=true" ]
rverEnv "JAVA_HOME" => "/usr/lib/j2sdk1.7-ibm/"
otstrapProperties "default.http.port" => "9080", "default.https.port" => "9443"
tion :create
server "myInstance" do
ean true
tion :start
server "myInstance" do
tion :stop
server "myInstance" do
tion :destroy
Adds, removes, and sets environment properties in installation-wide or instance-specific server.env file.
nil
.nil
.server_env "add to instance-specific server.env" do
rver_name "myInstance"
operties "JAVA_HOME" => "/usr/lib/j2sdk1.7-ibm/"
tion :add
server_env "remove from instance-specific server.env" do
rver_name "myInstance"
operties [ "JAVA_HOME" ]
tion :remove
server_env "set installation-wide server.env" do
operties "WLP_USER_DIR" => "/var/wlp"
tion :set
server_env "remove from installation-wide server.env" do
operties [ "WLP_USER_DIR" ]
tion :remove
Please see our contributing guide.
Use the issue tracker for reporting any bugs or enhancements. For any questions please use the WASdev forum.
The cookbook is maintained by IBM.
© Copyright IBM Corporation 2013, 2014.
nsed under the Apache License, Version 2.0 (the "License");
may not use this file except in compliance with the License.
may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
ss required by applicable law or agreed to in writing, software
ributed under the License is distributed on an "AS IS" BASIS,
OUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
the License for the specific language governing permissions and
tations under the License.