This is an automated email from the ASF dual-hosted git repository. btellier pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/james-project.git
commit d73c0038176e59d7891ba06ebe23cda749196c99 Author: LanKhuat <[email protected]> AuthorDate: Mon Mar 23 09:59:01 2020 +0700 JAMES-3117 Add healthcheck.propeties config file in guice packages --- .../destination/conf/healthcheck.properties | 30 +++++++++++++++ .../destination/conf/healthcheck.properties | 30 +++++++++++++++ .../destination/conf/healthcheck.properties | 30 +++++++++++++++ .../destination/conf/healthcheck.properties | 30 +++++++++++++++ .../destination/conf/healthcheck.properties | 30 +++++++++++++++ .../jpa/destination/conf/healthcheck.properties | 30 +++++++++++++++ .../memory/destination/conf/healthcheck.properties | 30 +++++++++++++++ src/site/site.xml | 1 + src/site/xdoc/server/config-healthcheck.xml | 44 ++++++++++++++++++++++ 9 files changed, 255 insertions(+) diff --git a/dockerfiles/run/guice/cassandra-ldap/destination/conf/healthcheck.properties b/dockerfiles/run/guice/cassandra-ldap/destination/conf/healthcheck.properties new file mode 100644 index 0000000..23b9879 --- /dev/null +++ b/dockerfiles/run/guice/cassandra-ldap/destination/conf/healthcheck.properties @@ -0,0 +1,30 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. + +# This template file can be used as example for James Server configuration +# DO NOT USE IT AS SUCH AND ADAPT IT TO YOUR NEEDS + +# Configuration file for Periodical Health Checks + +# Read https://james.apache.org/server/config-healthcheck.html for further details + +# Optional. Initial delay in seconds before PeriodicalHealthChecks starts. Default value is 60 +# healthcheck.initial.delay=60 + +# Optional. Period in seconds between two PeriodicalHealthChecks. Default value is 60 +# healthcheck.period=60 + diff --git a/dockerfiles/run/guice/cassandra-rabbitmq-ldap/destination/conf/healthcheck.properties b/dockerfiles/run/guice/cassandra-rabbitmq-ldap/destination/conf/healthcheck.properties new file mode 100644 index 0000000..23b9879 --- /dev/null +++ b/dockerfiles/run/guice/cassandra-rabbitmq-ldap/destination/conf/healthcheck.properties @@ -0,0 +1,30 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. + +# This template file can be used as example for James Server configuration +# DO NOT USE IT AS SUCH AND ADAPT IT TO YOUR NEEDS + +# Configuration file for Periodical Health Checks + +# Read https://james.apache.org/server/config-healthcheck.html for further details + +# Optional. Initial delay in seconds before PeriodicalHealthChecks starts. Default value is 60 +# healthcheck.initial.delay=60 + +# Optional. Period in seconds between two PeriodicalHealthChecks. Default value is 60 +# healthcheck.period=60 + diff --git a/dockerfiles/run/guice/cassandra-rabbitmq/destination/conf/healthcheck.properties b/dockerfiles/run/guice/cassandra-rabbitmq/destination/conf/healthcheck.properties new file mode 100644 index 0000000..23b9879 --- /dev/null +++ b/dockerfiles/run/guice/cassandra-rabbitmq/destination/conf/healthcheck.properties @@ -0,0 +1,30 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. + +# This template file can be used as example for James Server configuration +# DO NOT USE IT AS SUCH AND ADAPT IT TO YOUR NEEDS + +# Configuration file for Periodical Health Checks + +# Read https://james.apache.org/server/config-healthcheck.html for further details + +# Optional. Initial delay in seconds before PeriodicalHealthChecks starts. Default value is 60 +# healthcheck.initial.delay=60 + +# Optional. Period in seconds between two PeriodicalHealthChecks. Default value is 60 +# healthcheck.period=60 + diff --git a/dockerfiles/run/guice/cassandra/destination/conf/healthcheck.properties b/dockerfiles/run/guice/cassandra/destination/conf/healthcheck.properties new file mode 100644 index 0000000..23b9879 --- /dev/null +++ b/dockerfiles/run/guice/cassandra/destination/conf/healthcheck.properties @@ -0,0 +1,30 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. + +# This template file can be used as example for James Server configuration +# DO NOT USE IT AS SUCH AND ADAPT IT TO YOUR NEEDS + +# Configuration file for Periodical Health Checks + +# Read https://james.apache.org/server/config-healthcheck.html for further details + +# Optional. Initial delay in seconds before PeriodicalHealthChecks starts. Default value is 60 +# healthcheck.initial.delay=60 + +# Optional. Period in seconds between two PeriodicalHealthChecks. Default value is 60 +# healthcheck.period=60 + diff --git a/dockerfiles/run/guice/jpa-smtp/destination/conf/healthcheck.properties b/dockerfiles/run/guice/jpa-smtp/destination/conf/healthcheck.properties new file mode 100644 index 0000000..23b9879 --- /dev/null +++ b/dockerfiles/run/guice/jpa-smtp/destination/conf/healthcheck.properties @@ -0,0 +1,30 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. + +# This template file can be used as example for James Server configuration +# DO NOT USE IT AS SUCH AND ADAPT IT TO YOUR NEEDS + +# Configuration file for Periodical Health Checks + +# Read https://james.apache.org/server/config-healthcheck.html for further details + +# Optional. Initial delay in seconds before PeriodicalHealthChecks starts. Default value is 60 +# healthcheck.initial.delay=60 + +# Optional. Period in seconds between two PeriodicalHealthChecks. Default value is 60 +# healthcheck.period=60 + diff --git a/dockerfiles/run/guice/jpa/destination/conf/healthcheck.properties b/dockerfiles/run/guice/jpa/destination/conf/healthcheck.properties new file mode 100644 index 0000000..23b9879 --- /dev/null +++ b/dockerfiles/run/guice/jpa/destination/conf/healthcheck.properties @@ -0,0 +1,30 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. + +# This template file can be used as example for James Server configuration +# DO NOT USE IT AS SUCH AND ADAPT IT TO YOUR NEEDS + +# Configuration file for Periodical Health Checks + +# Read https://james.apache.org/server/config-healthcheck.html for further details + +# Optional. Initial delay in seconds before PeriodicalHealthChecks starts. Default value is 60 +# healthcheck.initial.delay=60 + +# Optional. Period in seconds between two PeriodicalHealthChecks. Default value is 60 +# healthcheck.period=60 + diff --git a/dockerfiles/run/guice/memory/destination/conf/healthcheck.properties b/dockerfiles/run/guice/memory/destination/conf/healthcheck.properties new file mode 100644 index 0000000..23b9879 --- /dev/null +++ b/dockerfiles/run/guice/memory/destination/conf/healthcheck.properties @@ -0,0 +1,30 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. + +# This template file can be used as example for James Server configuration +# DO NOT USE IT AS SUCH AND ADAPT IT TO YOUR NEEDS + +# Configuration file for Periodical Health Checks + +# Read https://james.apache.org/server/config-healthcheck.html for further details + +# Optional. Initial delay in seconds before PeriodicalHealthChecks starts. Default value is 60 +# healthcheck.initial.delay=60 + +# Optional. Period in seconds between two PeriodicalHealthChecks. Default value is 60 +# healthcheck.period=60 + diff --git a/src/site/site.xml b/src/site/site.xml index a8c662f..36ff240 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -130,6 +130,7 @@ <item name="Mail Repository Stores" href="/server/config-mailrepositorystore.html" /> <item name="Mailbox" href="/server/config-mailbox.html" /> <item name="Mailet Container" href="/server/config-mailetcontainer.html" /> + <item name="Periodical Health Checks" href="/server/config-healthcheck.html" /> <item name="POP3" href="/server/config-pop3.html" /> <item name="Quota" href="/server/config-quota.html" /> <item name="RabbitMQ" href="/server/config-rabbitmq.html" /> diff --git a/src/site/xdoc/server/config-healthcheck.xml b/src/site/xdoc/server/config-healthcheck.xml new file mode 100644 index 0000000..e7604bd --- /dev/null +++ b/src/site/xdoc/server/config-healthcheck.xml @@ -0,0 +1,44 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you 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. +--> +<document> + + <properties> + <title>Apache James Server 3 - PeriodicalHealthChecks Configuration</title> + </properties> + + <body> + + <section name="PeriodicalHealthChecks Configuration"> + + <p>Consult <a href="https://github.com/apache/james-project/blob/master/dockerfiles/run/guice/cassandra/destination/conf/healthcheck.properties";>healthcheck.properties</a> in GIT to get some examples and hints.</p> + + <p> + Use this configuration to define the initial delay and period for the PeriodicalHealthChecks. It is only applicable with Guice products. + </p> + + <dl> + <dt><strong>healthcheck.initial.delay</strong></dt> + <dd>Define the delay time before first health check starts (default: 60)</dd> + <dt><strong>healthcheck.period</strong></dt> + <dd>Define the period between two periodical health checks (default: 60)</dd> + </dl> + </section> + </body> +</document> \ No newline at end of file --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
