Skip to content

Commit

Permalink
ISPN-10509 modularizing server docs
Browse files Browse the repository at this point in the history
  • Loading branch information
oraNod committed Aug 27, 2019
1 parent 8f2282a commit 0aad49a
Show file tree
Hide file tree
Showing 118 changed files with 1,193 additions and 863 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
[id='server_configuring']
:context: server_configuring
= Configuring {brandname} Servers

include::{topics}/con_cluster_transport.adoc[leveloffset=+1]
include::{topics}/proc_switching_jgroups_stacks.adoc[leveloffset=+2]
include::{topics}/proc_tuning_transport_protocols.adoc[leveloffset=+2]
include::{topics}/ref_default_jgroups_stacks.adoc[leveloffset=+2]
include::{topics}/ref_tcp_ping_discovery.adoc[leveloffset=+2]
include::{topics}/ref_tcp_gossip_discovery.adoc[leveloffset=+2]
include::{topics}/ref_aws_s3_ping.adoc[leveloffset=+2]
include::{topics}/ref_google_stack.adoc[leveloffset=+2]
include::{topics}/ref_dns_ping.adoc[leveloffset=+2]
include::{topics}/ref_ispn_subsystem.adoc[leveloffset=+1]
include::{topics}/ref_cache_containers.adoc[leveloffset=+2]
include::{topics}/ref_cache_declarations.adoc[leveloffset=+2]
include::{topics}/ref_expiration_config.adoc[leveloffset=+2]
include::{topics}/ref_eviction_config.adoc[leveloffset=+2]
include::{topics}/ref_locking_config.adoc[leveloffset=+2]
include::{topics}/ref_datasource_config.adoc[leveloffset=+2]
include::{topics}/ref_state_xfer_config.adoc[leveloffset=+2]
include::{topics}/ref_endpoint_subsystem_config.adoc[leveloffset=+1]
include::{topics}/ref_hotrod_connector_declaration.adoc[leveloffset=+2]
include::{topics}/ref_memcached_connector_declaration.adoc[leveloffset=+2]
include::{topics}/ref_rest_connector_declaration.adoc[leveloffset=+2]
include::{topics}/ref_common_connector_settings.adoc[leveloffset=+2]
include::{topics}/con_protocol_interoperability.adoc[leveloffset=+1]
include::{topics}/proc_marshalling_requests.adoc[leveloffset=+1]
include::{topics}/proc_adding_protostuff_marshaller.adoc[leveloffset=+2]
include::{topics}/proc_adding_kyro_marshaller.adoc[leveloffset=+2]
include::{topics}/proc_storing_deserialized_objects.adoc[leveloffset=+2]
include::{topics}/proc_registering_custom_serializers.adoc[leveloffset=+2]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[id='server_start']
:context: getting_started
= Getting started with {brandname} server

include::{topics}/con_server.adoc[leveloffset=+1]
include::{topics}/proc_downloading_server.adoc[leveloffset=+1]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
[id='server_health']
:context: server_health
= Monitoring Server Health

include::{topics}/con_server_health.adoc[leveloffset=+1]
include::{topics}/proc_accessing_health_jmx.adoc[leveloffset=+1]
include::{topics}/proc_accessing_health_cli.adoc[leveloffset=+1]
include::{topics}/proc_accessing_health_rest.adoc[leveloffset=+1]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
[id='server_rolling_upgrade']
:context: rolling_upgrades
= Performing Rolling Upgrades

Upgrade {brandname} without downtime or data loss. You can perform rolling upgrades for {brandname} servers to start using a more recent version of {brandname}.

[NOTE]
====
This section explains how to upgrade {brandname} servers, see the appropriate documentation for your Hot Rod client for upgrade procedures.
====

include::{topics}/con_rolling_upgrades.adoc[leveloffset=+1]
include::{topics}/proc_setting_up_target_clusters.adoc[leveloffset=+1]
include::{topics}/proc_syncing_data_source_clusters.adoc[leveloffset=+1]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[id='server_scripts']
:context: scripting_server
= Scripting

include::{topics}/con_server_scripting.adoc[leveloffset=+1]
include::{topics}/proc_installing_scripts.adoc[leveloffset=+1]
include::{topics}/con_script_metadata.doc[leveloffset=+2]
include::{topics}/ref_script_comments.adoc[leveloffset=+3]
include::{topics}/ref_script_metadata_properties.adoc[leveloffset=+3]
include::{topics}/ref_script_bindings.adoc[leveloffset=+3]
include::{topics}/ref_script_parameters.adoc[leveloffset=+3]
include::{topics}/proc_running_scripts.adoc[leveloffset=+1]
include::{topics}/ref_distributed_script_execution.adoc[leveloffset=+1]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
[id='server_multitenancy']
:context: server_multitenancy
= Multitenancy

include::{topics}/con_multitenancy.adoc[leveloffset=+1]
include::{topics}/ref_multitenancy_rest.adoc[leveloffset=+1]
include::{topics}/ref_multitenancy_hotrod.adoc[leveloffset=+1]
include::{topics}/ref_multitenancy_router.adoc[leveloffset=+1]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
[id='server_modes']
:context: operating_modes
= Operating modes
{brandname} Server provides two different operating modes: standalone and domain.

include::{topics}/con_standalone_server.adoc[leveloffset=+1]
include::{topics}/con_domain_mode.adoc[leveloffset=+1]
include::{topics}/con_host_controller.adoc[leveloffset=+2]
include::{topics}/con_domain_controller.adoc[leveloffset=+2]
include::{topics}/con_server_groups.adoc[leveloffset=+1]
include::{topics}/ref_server_group_config.adoc[leveloffset=+2]
include::{topics}/con_server_nodes.adoc[leveloffset=+1]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
[id='server_single_port']
:context: single_port
= Single Port

include::{topics}/con_single_port.adoc[leveloffset=+1]
include::{topics}/con_single_port_router.adoc[leveloffset=+1]
include::{topics}/proc_testing_single_port_router.adoc[leveloffset=+2]
include::{topics}/con_single_port_hotrod_detection.adoc[leveloffset=+1]
include::{topics}/con_single_port_tlsalpn.adoc[leveloffset=+2]
include::{topics}/proc_enabling_tlsalpn.adoc[leveloffset=+3]

// Restore the parent context.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-8601422-1', 'auto');
ga('send', 'pageview');

</script>

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<link rel="canonical" href="http://infinispan.org/docs/stable/user_guide/user_guide.html">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/jstree/3.3.1/themes/default/style.min.css">
<link rel="stylesheet" href="../../css/css.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jstree/3.3.1/jstree.min.js"></script>
<script src="../../js/js.js"></script>
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
//Directory attributes
:images_dir: images
:stories: ../../stories
:topics: ../../topics

//Community doc attributes
include::{topics}/attributes/community-attributes.adoc[]

//Community title attributes
:toc2:
:icons: font
:toclevels: 3
:numbered:
:stem: asciimath

//Title
= Connecting to {brandname} {infinispanversion} with Remote Clients

//User stories
include::stories.adoc[]
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
//Reference user stories or topics.
//Please review authoring guidelines in the Contributors Guide.

include::{topics}/server_protocols.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-8601422-1', 'auto');
ga('send', 'pageview');

</script>

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<link rel="canonical" href="http://infinispan.org/docs/stable/user_guide/user_guide.html">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/jstree/3.3.1/themes/default/style.min.css">
<link rel="stylesheet" href="../../css/css.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jstree/3.3.1/jstree.min.js"></script>
<script src="../../js/js.js"></script>
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
//Directory attributes
:images_dir: images
:stories: ../../stories
:topics: ../../topics

//Community doc attributes
include::{topics}/attributes/community-attributes.adoc[]

//Community title attributes
:toc2:
:icons: font
:toclevels: 3
:numbered:
:stem: asciimath

//Title
= Configuring Hot Rod Java Clients for {brandname} {infinispanversion}

//User stories
include::stories.adoc[]
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
//Reference user stories or topics.
//Please review authoring guidelines in the Contributors Guide.

include::{topics}/server_protocols_hotrod.adoc[leveloffset=+1]
//topic included in server_protocols_hotrod.adoc
//include::{topics}/server_protocols_hotrod_transaction.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-8601422-1', 'auto');
ga('send', 'pageview');

</script>

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<link rel="canonical" href="http://infinispan.org/docs/stable/user_guide/user_guide.html">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/jstree/3.3.1/themes/default/style.min.css">
<link rel="stylesheet" href="../../css/css.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jstree/3.3.1/jstree.min.js"></script>
<script src="../../js/js.js"></script>
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
//Directory attributes
:images_dir: images
:stories: ../../stories
:topics: ../../topics

//Community doc attributes
include::{topics}/attributes/community-attributes.adoc[]

//Community title attributes
:toc2:
:icons: font
:toclevels: 3
:numbered:
:stem: asciimath

//Title
= Configuring Memcached Clients for {brandname} {infinispanversion}

//User stories
include::stories.adoc[]
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
//Reference user stories or topics.
//Please review authoring guidelines in the Contributors Guide.

include::{topics}/server_protocols_memcached.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-8601422-1', 'auto');
ga('send', 'pageview');

</script>

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<link rel="canonical" href="http://infinispan.org/docs/stable/user_guide/user_guide.html">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/jstree/3.3.1/themes/default/style.min.css">
<link rel="stylesheet" href="../../css/css.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jstree/3.3.1/jstree.min.js"></script>
<script src="../../js/js.js"></script>
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
//Directory attributes
:images_dir: images
:stories: ../../stories
:topics: ../../topics

//Community doc attributes
include::{topics}/attributes/community-attributes.adoc[]

//Community title attributes
:toc2:
:icons: font
:toclevels: 3
:numbered:
:stem: asciimath

//Title
= Configuring REST Clients for {brandname} {infinispanversion}

//User stories
include::stories.adoc[]
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
//Reference user stories or topics.
//Please review authoring guidelines in the Contributors Guide.

include::{topics}/server_protocols_rest.adoc[leveloffset=+1]
4 changes: 2 additions & 2 deletions documentation/src/main/asciidoc/titles/server/server.asciidoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
//Directory attributes
:images_dir: images
:stories: ../../stories
:topics: ../../topics
:topics: ../topics

//Community doc attributes
include::{topics}/attributes/community-attributes.adoc[]
include::../{topics}/attributes/community-attributes.adoc[]

//Community title attributes
:toc2:
Expand Down
23 changes: 8 additions & 15 deletions documentation/src/main/asciidoc/titles/server/stories.adoc
Original file line number Diff line number Diff line change
@@ -1,18 +1,11 @@
//Reference user stories or topics.
//Please review authoring guidelines in the Contributors Guide.

include::{topics}/con_server.adoc[leveloffset=+1]
include::{topics}/operating_modes.adoc[leveloffset=+1]
include::{topics}/configuring_server.adoc[leveloffset=+1]
include::{topics}/rolling_upgrades.adoc[leveloffset=+1]
include::{topics}/server_protocols.adoc[leveloffset=+1]
include::{topics}/server_protocols_hotrod.adoc[leveloffset=+1]
//topic included in server_protocols_hotrod.adoc
//include::{topics}/server_protocols_hotrod_transaction.adoc[leveloffset=+1]
include::{topics}/server_protocols_rest.adoc[leveloffset=+1]
include::{topics}/server_protocols_memcached.adoc[leveloffset=+1]
include::{topics}/scripting.adoc[leveloffset=+1]
include::{topics}/server_tasks.adoc[leveloffset=+1]
include::{topics}/server_health.adoc[leveloffset=+1]
include::{topics}/server_multitenancy.adoc[leveloffset=+1]
include::{topics}/single_port.adoc[leveloffset=+1]
include::{stories}/assembly_getting_started_server.adoc[leveloffset=+1]
include::{stories}/assembly_server_operating_modes.adoc[leveloffset=+1]
include::{stories}/assembly_configuring_server.adoc[leveloffset=+1]
include::{stories}/assembly_performing_rolling_upgrades.adoc[leveloffset=+1]
include::{stories}/assembly_scripting_server.adoc[leveloffset=+1]
include::{stories}/assembly_monitoring_server_health.adoc[leveloffset=+1]
include::{stories}/assembly_server_multitenancy.adoc[leveloffset=+1]
include::{stories}/assembly_server_single_port.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"outcome" => "success",
"result" => {
"cache-health" => "HEALTHY",
"cluster-health" => ["test"],
"cluster-name" => "clustered",
"free-memory" => 99958L,
"log-tail" => [
"<time_stamp> INFO [org.infinispan.server.endpoint] (MSC service thread 1-5) DGENDPT10001: HotRodServer listening on 127.0.0.1:11222",
"<time_stamp> INFO [org.infinispan.server.endpoint] (MSC service thread 1-1) DGENDPT10001: MemcachedServer listening on 127.0.0.1:11211",
"<time_stamp> INFO [org.jboss.as.clustering.infinispan] (MSC service thread 1-6) DGISPN0001: Started ___protobuf_metadata cache from clustered container",
"<time_stamp> INFO [org.jboss.as.clustering.infinispan] (MSC service thread 1-6) DGISPN0001: Started ___script_cache cache from clustered container",
"<time_stamp> INFO [org.jboss.as.clustering.infinispan] (MSC service thread 1-5) DGISPN0001: Started ___hotRodTopologyCache cache from clustered container",
"<time_stamp> INFO [org.infinispan.rest.NettyRestServer] (MSC service thread 1-6) ISPN012003: REST server starting, listening on 127.0.0.1:8080",
"<time_stamp> INFO [org.infinispan.server.endpoint] (MSC service thread 1-6) DGENDPT10002: REST mapped to /rest",
"<time_stamp> INFO [org.jboss.as] (Controller Boot Thread) WFLYSRV0060: Http management interface listening on http://127.0.0.1:9990/management",
"<time_stamp> INFO [org.jboss.as] (Controller Boot Thread) WFLYSRV0051: Admin console listening on http://127.0.0.1:9990",
"<time_stamp> INFO [org.jboss.as] (Controller Boot Thread) WFLYSRV0025: {brandname} Server <build_version> (WildFly Core <build_version>) started in 8681ms - Started 196 of 237 services (121 services are lazy, passive or on-demand)"
],
"number-of-cpus" => 8,
"number-of-nodes" => 1,
"total-memory" => 235520L
}
}

0 comments on commit 0aad49a

Please sign in to comment.