This is an automated email from the ASF dual-hosted git repository. dmagda pushed a commit to branch IGNITE-7595 in repository https://gitbox.apache.org/repos/asf/ignite.git
The following commit(s) were added to refs/heads/IGNITE-7595 by this push: new 5c27b81 Ignite docs: rearranged the table of contents 5c27b81 is described below commit 5c27b81b0b5133eb704634a3e699d9b70d49b70c Author: Denis Magda <dma...@gridgain.com> AuthorDate: Mon Oct 5 12:52:47 2020 -0700 Ignite docs: rearranged the table of contents --- docs/_data/toc.yaml | 459 ++++++++++----------- docs/_docs/{ => clustering}/baseline-topology.adoc | 0 .../{ => code-deployment}/deploying-user-code.adoc | 2 +- .../{ => code-deployment}/peer-class-loading.adoc | 2 +- .../configuring-caches/configuration-overview.adoc | 15 +- .../_docs/{ => configuring-caches}/near-cache.adoc | 0 .../partition-loss-policy.adoc | 0 docs/_docs/data-modeling/affinity-collocation.adoc | 2 +- docs/_docs/data-modeling/data-partitioning.adoc | 2 +- docs/_docs/data-rebalancing.adoc | 4 +- docs/_docs/data-streaming.adoc | 2 +- .../collocated-computations.adoc | 2 +- .../distributed-computing.adoc | 6 +- .../distributed-computing/load-balancing.adoc | 2 +- docs/_docs/key-value-api/binary-objects.adoc | 2 +- docs/_docs/key-value-api/continuous-queries.adoc | 4 +- .../memory-configuration/eviction-policies.adoc | 2 +- .../{ => monitoring-metrics}/cluster-states.adoc | 0 docs/_docs/monitoring-metrics/metrics.adoc | 2 +- docs/_docs/monitoring-metrics/system-views.adoc | 2 +- .../net-platform-cache.adoc} | 2 +- .../handling-exceptions.adoc | 2 +- docs/_docs/restapi.adoc | 4 +- docs/_docs/services/services.adoc | 2 +- docs/_docs/setup.adoc | 11 + docs/_docs/starting-nodes.adoc | 17 +- docs/_docs/thin-clients/python-thin-client.adoc | 2 +- docs/_docs/tools/control-script.adoc | 8 +- docs/_docs/transactions/mvcc.adoc | 2 +- docs/_docs/understanding-configuration.adoc | 14 +- 30 files changed, 302 insertions(+), 272 deletions(-) diff --git a/docs/_data/toc.yaml b/docs/_data/toc.yaml index a8e045f..d675358 100644 --- a/docs/_data/toc.yaml +++ b/docs/_data/toc.yaml @@ -21,7 +21,7 @@ - title: Installation url: installation items: - - title: Installing Using ZIP Archive + - title: Installing Using ZIP Archive url: installation/installing-using-zip - title: Installing Using Docker url: installation/installing-using-docker @@ -39,14 +39,14 @@ url: installation/vmware-installation - title: Setting Up items: - - title: Setting Up Ignite for Java + - title: Understanding Configuration + url: understanding-configuration + - title: Setting Up url: setup - - title: Setting Up Ignite for .NET/C# - url: setup-dotnet -- title: Understanding Configuration - url: understanding-configuration -- title: Configuring Logging - url: logging + - title: Configuring Logging + url: logging + - title: Resources Injection + url: resources-injection - title: Starting and Stopping Nodes url: starting-nodes - title: Clustering @@ -63,9 +63,41 @@ url: clustering/network-configuration - title: Connecting Client Nodes url: clustering/connect-client-nodes + - title: Baseline Topology + url: clustering/baseline-topology - title: Running Client Nodes Behind NAT url: clustering/running-client-nodes-behind-nat -- title: Data Modeling +- title: Thin Clients + items: + - title: Thin Clients Overview + url: thin-clients/getting-started-with-thin-clients + - title: Java Thin Client + url: thin-clients/java-thin-client + - title: .NET Thin Client + url: thin-clients/dotnet-thin-client + - title: C++ Thin Client + url: thin-clients/cpp-thin-client + - title: Python Thin Client + url: thin-clients/python-thin-client + - title: PHP Thin Client + url: thin-clients/php-thin-client + - title: Node.js Thin Client + url: thin-clients/nodejs-thin-client + - title: Binary Client Protocol + items: + - title: Binary Client Protocol + url: binary-client-protocol/binary-client-protocol + - title: Data Format + url: binary-client-protocol/data-format + - title: Key-Value Queries + url: binary-client-protocol/key-value-queries + - title: SQL and Scan Queries + url: binary-client-protocol/sql-and-scan-queries + - title: Binary Types Metadata + url: binary-client-protocol/binary-type-metadata + - title: Cache Configuration + url: binary-client-protocol/cache-configuration +- title: Data Modeling items: - title: Introduction url: data-modeling/data-modeling @@ -83,28 +115,14 @@ url: memory-configuration/data-regions - title: Eviction Policies url: memory-configuration/eviction-policies -- title: Configuring Caches - items: - - title: Cache Configuration - url: configuring-caches/configuration-overview - - title: Configuring Partition Backups - url: configuring-caches/configuring-backups - - title: Atomicity Modes - url: configuring-caches/atomicity-modes - - title: Expiry Policy - url: configuring-caches/expiry-policies - - title: On-Heap Caching - url: configuring-caches/on-heap-caching - - title: Cache Groups - url: configuring-caches/cache-groups -- title: Persistence +- title: Configuring Persistence items: - title: Ignite Persistence url: persistence/native-persistence - title: External Storage url: persistence/external-storage - title: Swapping - url: persistence/swap + url: persistence/swap - title: Implementing Custom Cache Store url: persistence/custom-cache-store - title: Cluster Snapshots @@ -113,21 +131,29 @@ url: persistence/disk-compression - title: Tuning Persistence url: persistence/persistence-tuning -- title: Baseline Topology - url: baseline-topology -- title: Cluster States - url: cluster-states +- title: Configuring Caches + items: + - title: Cache Configuration + url: configuring-caches/configuration-overview + - title: Configuring Partition Backups + url: configuring-caches/configuring-backups + - title: Partition Loss Policy + url: configuring-caches/partition-loss-policy + - title: Atomicity Modes + url: configuring-caches/atomicity-modes + - title: Expiry Policy + url: configuring-caches/expiry-policies + - title: On-Heap Caching + url: configuring-caches/on-heap-caching + - title: Cache Groups + url: configuring-caches/cache-groups + - title: Near Caches + url: configuring-caches/near-cache - title: Data Rebalancing url: data-rebalancing -- title: Partition Loss Policy - url: partition-loss-policy -- title: Deploying User Code - url: deploying-user-code -- title: Peer Class Loading - url: peer-class-loading - title: Data Streaming url: data-streaming -- title: Using Key-Value Cache API +- title: Using Key-Value API items: - title: Basic Cache Operations url: key-value-api/basic-cache-operations @@ -137,8 +163,6 @@ url: key-value-api/using-scan-queries - title: Read Repair url: read-repair -- title: Using Continuous Queries - url: key-value-api/continuous-queries - title: Performing Transactions url: key-value-api/transactions - title: Working with SQL @@ -148,9 +172,9 @@ - title: Understanding Schemas url: SQL/schemas - title: Defining Indexes - url: SQL/indexes + url: SQL/indexes - title: Using SQL API - url: SQL/sql-api + url: SQL/sql-api - title: Distributed Joins url: SQL/distributed-joins - title: SQL Transactions @@ -161,11 +185,50 @@ url: SQL/JDBC/jdbc-driver - title: JDBC Client Driver url: SQL/JDBC/jdbc-client-driver + - title: ODBC Driver + items: + - title: ODBC Driver + url: SQL/ODBC/odbc-driver + - title: Connection String and DSN + url: /SQL/ODBC/connection-string-dsn + - title: Querying and Modifying Data + url: SQL/ODBC/querying-modifying-data + - title: Specification + url: SQL/ODBC/specification + - title: Data Types + url: SQL/ODBC/data-types + - title: Error Codes + url: SQL/ODBC/error-codes - title: Multiversion Concurrency Control url: transactions/mvcc -- title: Distributed Computing +- title: SQL Reference + url: sql-reference/sql-reference-overview + items: + - title: SQL Conformance + url: sql-reference/sql-conformance + - title: Data Definition Language (DDL) + url: sql-reference/ddl + - title: Data Manipulation Language (DML) + url: sql-reference/dml + - title: Transactions + url: sql-reference/transactions + - title: Operational Commands + url: sql-reference/operational-commands + - title: Aggregate functions + url: sql-reference/aggregate-functions + - title: Numeric Functions + url: sql-reference/numeric-functions + - title: String Functions + url: sql-reference/string-functions + - title: Data and Time Functions + url: sql-reference/date-time-functions + - title: System Functions + url: sql-reference/system-functions + - title: Data Types + url: sql-reference/data-types +- title: Distributed Computing items: - - title: Distributed Computing API + - title: Distributed Computing API url: distributed-computing/distributed-computing - title: Cluster Groups url: distributed-computing/cluster-groups @@ -173,127 +236,172 @@ url: distributed-computing/executor-service - title: MapReduce API url: distributed-computing/map-reduce - - title: Load Balancing + - title: Load Balancing url: distributed-computing/load-balancing - title: Fault Tolerance url: distributed-computing/fault-tolerance - title: Job Scheduling url: distributed-computing/job-scheduling -- title: Colocating Computations with Data - url: collocated-computations -- title: Working with Events + - title: Colocating Computations with Data + url: distributed-computing/collocated-computations +- title: Code Deployment items: - - title: Enabling and Listenting to Events - url: events/listening-to-events - - title: Events - url: events/events -- title: Near Caches - url: near-cache -- title: .NET Platform Cache - url: platform-cache -- title: Services - url: services/services -- title: Distributed Data Structures - items: - - title: Queue and Set - url: data-structures/queue-and-set - - title: Atomic Types - url: data-structures/atomic-types - - title: CountDownLatch - url: data-structures/countdownlatch - - title: Atomic Sequence - url: data-structures/atomic-sequence - - title: Semaphore - url: data-structures/semaphore + - title: Deploying User Code + url: code-deployment/deploying-user-code + - title: Peer Class Loading + url: code-deployment/peer-class-loading - title: Machine Learning items: - title: Machine Learning url: machine-learning/machine-learning - - title: Partition Based Dataset + - title: Partition Based Dataset url: machine-learning/partition-based-dataset - - title: Updating Trained Models + - title: Updating Trained Models url: machine-learning/updating-trained-models - title: Binary Classification items: - title: Introduction url: machine-learning/binary-classification/introduction - - title: Linear SVM (Support Vector Machine) + - title: Linear SVM (Support Vector Machine) url: machine-learning/binary-classification/linear-svm - - title: Decision Trees + - title: Decision Trees url: machine-learning/binary-classification/decision-trees - title: Multilayer Perceptron url: machine-learning/binary-classification/multilayer-perceptron - - title: Logistic Regression + - title: Logistic Regression url: machine-learning/binary-classification/logistic-regression - - title: k-NN Classification + - title: k-NN Classification url: machine-learning/binary-classification/knn-classification - - title: ANN (Approximate Nearest Neighbor) + - title: ANN (Approximate Nearest Neighbor) url: machine-learning/binary-classification/ann - - title: Naive Bayes + - title: Naive Bayes url: machine-learning/binary-classification/naive-bayes - - title: Regression + - title: Regression items: - title: Introduction url: machine-learning/regression/introduction - - title: Linear Regression + - title: Linear Regression url: machine-learning/regression/linear-regression - - title: Decision Trees Regression + - title: Decision Trees Regression url: machine-learning/regression/decision-trees-regression - - title: k-NN Regression + - title: k-NN Regression url: machine-learning/regression/knn-regression - - title: Clustering + - title: Clustering items: - title: Introduction url: machine-learning/clustering/introduction - - title: K-Means Clustering + - title: K-Means Clustering url: machine-learning/clustering/k-means-clustering - - title: Gaussian mixture (GMM) + - title: Gaussian mixture (GMM) url: machine-learning/clustering/gaussian-mixture - - title: Preprocessing + - title: Preprocessing url: machine-learning/preprocessing - title: Model Selection items: - title: Introduction url: machine-learning/model-selection/introduction - - title: Evaluator + - title: Evaluator url: machine-learning/model-selection/evaluator - - title: Split the dataset on test and train datasets + - title: Split the dataset on test and train datasets url: machine-learning/model-selection/split-the-dataset-on-test-and-train-datasets - - title: Hyper-parameter tuning + - title: Hyper-parameter tuning url: machine-learning/model-selection/hyper-parameter-tuning - - title: Pipeline API + - title: Pipeline API url: machine-learning/model-selection/pipeline-api - - title: Multiclass Classification + - title: Multiclass Classification url: machine-learning/multiclass-classification - - title: Ensemble Methods + - title: Ensemble Methods items: - title: url: machine-learning/ensemble-methods/introduction - - title: Stacking + - title: Stacking url: machine-learning/ensemble-methods/stacking - - title: Bagging + - title: Bagging url: machine-learning/ensemble-methods/baggin - - title: Random Forest + - title: Random Forest url: machine-learning/ensemble-methods/random-forest - - title: Gradient Boosting + - title: Gradient Boosting url: machine-learning/ensemble-methods/gradient-boosting - - title: Recommendation Systems + - title: Recommendation Systems url: machine-learning/recommendation-systems - title: Importing Model items: - - title: Introduction + - title: Introduction url: machine-learning/importing-model/introduction - - title: Import Model from XGBoost + - title: Import Model from XGBoost url: machine-learning/importing-model/model-import-from-gxboost - - title: Import Model from Apache Spark + - title: Import Model from Apache Spark url: machine-learning/importing-model/model-import-from-apache-spark - +- title: Using Continuous Queries + url: key-value-api/continuous-queries +- title: Using Ignite Services + url: services/services +- title: Distributed Data Structures + items: + - title: Queue and Set + url: data-structures/queue-and-set + - title: Atomic Types + url: data-structures/atomic-types + - title: CountDownLatch + url: data-structures/countdownlatch + - title: Atomic Sequence + url: data-structures/atomic-sequence + - title: Semaphore + url: data-structures/semaphore +- title: REST API + url: restapi +- title: .NET Specific + items: + - title: Configuration Options + url: net-specific/net-configuration-options + - title: Deployment Options + url: net-specific/net-deployment-options + - title: Standalone Nodes + url: net-specific/net-standalone-nodes + - title: Logging + url: net-specific/net-logging + - title: LINQ + url: net-specific/net-linq + - title: Java Services Execution + url: net-specific/net-java-services-execution + - title: .NET Platform Cache + url: net-specific/net-platform-cache + - title: Plugins + url: net-specific/net-plugins + - title: Serialization + url: net-specific/net-serialization + - title: Cross-Platform Support + url: net-specific/net-cross-platform-support + - title: Platform Interoperability + url: net-specific/net-platform-interoperability + - title: Remote Assembly Loading + url: net-specific/net-remote-assembly-loading + - title: Troubleshooting + url: net-specific/net-troubleshooting + - title: Integrations + items: + - title: ASP.NET Output Caching + url: net-specific/asp-net-output-caching + - title: ASP.NET Session State Caching + url: net-specific/asp-net-session-state-caching + - title: Entity Framework 2nd Level Cache + url: net-specific/net-entity-framework-cache +- title: C++ Specific + items: + - title: Serialization + url: cpp-specific/cpp-serialization + - title: Platform Interoperability + url: cpp-specific/cpp-platform-interoperability + - title: Objects Lifetime + url: cpp-specific/cpp-objects-lifetime - title: Monitoring items: - title: Introduction url: monitoring-metrics/intro - title: Cluster ID and Tag url: monitoring-metrics/cluster-id + - title: Cluster States + url: monitoring-metrics/cluster-states - title: Metrics items: - title: Configuring Metrics @@ -310,6 +418,28 @@ url: monitoring-metrics/system-views - title: Tracing url: monitoring-metrics/tracing +- title: Working with Events + items: + - title: Enabling and Listenting to Events + url: events/listening-to-events + - title: Events + url: events/events +- title: Tools + items: + - title: Control Script + url: tools/control-script + - title: Visor CMD + url: tools/visor-cmd + - title: GridGain Control Center + url: tools/gg-control-center + - title: SQLLine + url: tools/sqlline + - title: Tableau + url: tools/tableau + - title: Informatica + url: tools/informatica + - title: Pentaho + url: tools/pentaho - title: Security url: security items: @@ -325,52 +455,6 @@ url: security/master-key-rotation - title: Sandbox url: security/sandbox -- title: Thin Clients - items: - - title: Thin Clients Overview - url: thin-clients/getting-started-with-thin-clients - - title: Java Thin Client - url: thin-clients/java-thin-client - - title: .NET Thin Client - url: thin-clients/dotnet-thin-client - - title: C++ Thin Client - url: thin-clients/cpp-thin-client - - title: Python Thin Client - url: thin-clients/python-thin-client - - title: PHP Thin Client - url: thin-clients/php-thin-client - - title: Node.js Thin Client - url: thin-clients/nodejs-thin-client - - title: Binary Client Protocol - items: - - title: Binary Client Protocol - url: binary-client-protocol/binary-client-protocol - - title: Data Format - url: binary-client-protocol/data-format - - title: Key-Value Queries - url: binary-client-protocol/key-value-queries - - title: SQL and Scan Queries - url: binary-client-protocol/sql-and-scan-queries - - title: Binary Types Metadata - url: binary-client-protocol/binary-type-metadata - - title: Cache Configuration - url: binary-client-protocol/cache-configuration -- title: ODBC Driver - items: - - title: ODBC Driver - url: SQL/ODBC/odbc-driver - - title: Connection String and DSN - url: /SQL/ODBC/connection-string-dsn - - title: Querying and Modifying Data - url: SQL/ODBC/querying-modifying-data - - title: Specification - url: SQL/ODBC/specification - - title: Data Types - url: SQL/ODBC/data-types - - title: Error Codes - url: SQL/ODBC/error-codes -- title: REST API - url: restapi - title: Extensions and Integrations items: - title: Spring @@ -433,93 +517,8 @@ url: extensions-and-integrations/cassandra/ddl-generator - title: PHP PDO url: extensions-and-integrations/php-pdo -- title: .NET Specific - items: - - title: Configuration Options - url: net-specific/net-configuration-options - - title: Deployment Options - url: net-specific/net-deployment-options - - title: Standalone Nodes - url: net-specific/net-standalone-nodes - - title: Logging - url: net-specific/net-logging - - title: LINQ - url: net-specific/net-linq - - title: Java Services Execution - url: net-specific/net-java-services-execution - - title: Plugins - url: net-specific/net-plugins - - title: Serialization - url: net-specific/net-serialization - - title: Cross-Platform Support - url: net-specific/net-cross-platform-support - - title: Platform Interoperability - url: net-specific/net-platform-interoperability - - title: Remote Assembly Loading - url: net-specific/net-remote-assembly-loading - - title: Troubleshooting - url: net-specific/net-troubleshooting - - title: Integrations - items: - - title: ASP.NET Output Caching - url: net-specific/asp-net-output-caching - - title: ASP.NET Session State Caching - url: net-specific/asp-net-session-state-caching - - title: Entity Framework 2nd Level Cache - url: net-specific/net-entity-framework-cache -- title: C++ Specific - items: - - title: Serialization - url: cpp-specific/cpp-serialization - - title: Platform Interoperability - url: cpp-specific/cpp-platform-interoperability - - title: Objects Lifetime - url: cpp-specific/cpp-objects-lifetime -- title: Tools - items: - - title: Control Script - url: tools/control-script - - title: Visor CMD - url: tools/visor-cmd - - title: GridGain Control Center - url: tools/gg-control-center - - title: SQLLine - url: tools/sqlline - - title: Tableau - url: tools/tableau - - title: Informatica - url: tools/informatica - - title: Pentaho - url: tools/pentaho - title: Plugins url: plugins -- title: SQL Reference - url: sql-reference/sql-reference-overview - items: - - title: SQL Conformance - url: sql-reference/sql-conformance - - title: Data Definition Language (DDL) - url: sql-reference/ddl - - title: Data Manipulation Language (DML) - url: sql-reference/dml - - title: Transactions - url: sql-reference/transactions - - title: Operational Commands - url: sql-reference/operational-commands - - title: Aggregate functions - url: sql-reference/aggregate-functions - - title: Numeric Functions - url: sql-reference/numeric-functions - - title: String Functions - url: sql-reference/string-functions - - title: Data and Time Functions - url: sql-reference/date-time-functions - - title: System Functions - url: sql-reference/system-functions - - title: Data Types - url: sql-reference/data-types -- title: Resources Injection - url: resources-injection - title: Performance and Troubleshooting items: - title: General Performance Tips diff --git a/docs/_docs/baseline-topology.adoc b/docs/_docs/clustering/baseline-topology.adoc similarity index 100% rename from docs/_docs/baseline-topology.adoc rename to docs/_docs/clustering/baseline-topology.adoc diff --git a/docs/_docs/deploying-user-code.adoc b/docs/_docs/code-deployment/deploying-user-code.adoc similarity index 90% rename from docs/_docs/deploying-user-code.adoc rename to docs/_docs/code-deployment/deploying-user-code.adoc index b8baadd..87145cb 100644 --- a/docs/_docs/deploying-user-code.adoc +++ b/docs/_docs/code-deployment/deploying-user-code.adoc @@ -1,7 +1,7 @@ = Deploying User Code :javaFile: {javaCodeDir}/UserCodeDeployment.java -In addition to link:peer-class-loading[peer class loading], you can deploy user code by configuring `UriDeploymentSpi`. With this approach, you specify the location of your libraries in the node configuration. +In addition to link:code-deployment/peer-class-loading[peer class loading], you can deploy user code by configuring `UriDeploymentSpi`. With this approach, you specify the location of your libraries in the node configuration. Ignite scans the location periodically and redeploys the classes if they change. The location may be a file system directory or an HTTP(S) location. When Ignite detects that the libraries are removed from the location, the classes are undeployed from the cluster. diff --git a/docs/_docs/peer-class-loading.adoc b/docs/_docs/code-deployment/peer-class-loading.adoc similarity index 98% rename from docs/_docs/peer-class-loading.adoc rename to docs/_docs/code-deployment/peer-class-loading.adoc index 3dc446f..bb5cd71 100644 --- a/docs/_docs/peer-class-loading.adoc +++ b/docs/_docs/code-deployment/peer-class-loading.adoc @@ -13,7 +13,7 @@ When enabled, peer class loading is used to deploy the following classes: * Tasks and jobs submitted via the link:distributed-computing/distributed-computing[compute interface]. * Transformers and filters used with link:key-value-api/using-scan-queries[scan queries] and link:key-value-api/continuous-queries[continuous queries]. * Stream transformers, receivers and visitors used with link:data-streaming#data-streamers[data streamers]. -* link:collocated-computations#entry-processor[Entry processors]. +* link:distributed-computing/collocated-computations#entry-processor[Entry processors]. When defining the classes listed above, we recommend that each class is created as either a separate class or inner static class and not as a lambda or anonymous inner class. Non-static inner classes are serialized together with its enclosing class. If some fields of the enclosing class cannot be serialized, you will get serialization exceptions. diff --git a/docs/_docs/configuring-caches/configuration-overview.adoc b/docs/_docs/configuring-caches/configuration-overview.adoc index e2b0277..231db52 100644 --- a/docs/_docs/configuring-caches/configuration-overview.adoc +++ b/docs/_docs/configuring-caches/configuration-overview.adoc @@ -2,9 +2,16 @@ This chapter explains how you can set cache configuration parameters. Once a cache is created, you cannot change its configuration parameters. -//// -*TODO: add introductory words* -//// + +[NOTE] +==== +[discrete] +=== Caches vs. Tables in Ignite + +The cache-driven configuration approach is one of the configuration options. You can also configure caches/tables using +standard SQL commands such as `CREATE TABLE`. Refer to the link:data-modeling/data-modeling#key-value-cache-vs-sql-table[Caches vs. Tables] +section to know the relation between caches and tables in Ignite. +==== == Configuration Example @@ -54,7 +61,7 @@ a| This parameter controls the way the rebalancing process is performed. Possibl | `0` |`partitionLossPolicy` -| link:partition-loss-policy[Partition loss policy]. +| link:configuring-caches/partition-loss-policy[Partition loss policy]. | `IGNORE` |`readFromBackup` diff --git a/docs/_docs/near-cache.adoc b/docs/_docs/configuring-caches/near-cache.adoc similarity index 100% rename from docs/_docs/near-cache.adoc rename to docs/_docs/configuring-caches/near-cache.adoc diff --git a/docs/_docs/partition-loss-policy.adoc b/docs/_docs/configuring-caches/partition-loss-policy.adoc similarity index 100% rename from docs/_docs/partition-loss-policy.adoc rename to docs/_docs/configuring-caches/partition-loss-policy.adoc diff --git a/docs/_docs/data-modeling/affinity-collocation.adoc b/docs/_docs/data-modeling/affinity-collocation.adoc index c271f28..7e19ae9 100644 --- a/docs/_docs/data-modeling/affinity-collocation.adoc +++ b/docs/_docs/data-modeling/affinity-collocation.adoc @@ -23,7 +23,7 @@ And here is how data is distributed when you colocate persons with the companies *TODO image* //// -You can also colocate a computation task with the data. See link:collocated-computations[Colocating Computations With Data]. +You can also colocate a computation task with the data. See link:distributed-computing/collocated-computations[Colocating Computations With Data]. //// *TODO: add examples and use cases* //// diff --git a/docs/_docs/data-modeling/data-partitioning.adoc b/docs/_docs/data-modeling/data-partitioning.adoc index 0b249a6..b0eedde 100644 --- a/docs/_docs/data-modeling/data-partitioning.adoc +++ b/docs/_docs/data-modeling/data-partitioning.adoc @@ -121,6 +121,6 @@ Refer to the link:data-rebalancing[Data Rebalancing] page for details. == Partition Loss Policy -It may happen that throughout the cluster’s lifecycle, some of the data partitions are lost due to the failure of some primary node and backup nodes that held a copy of the partitions. Such a situation leads to a partial data loss and needs to be addressed according to your use case. For detailed information about partition loss policies, see link:partition-loss-policy[Partition Loss Policy]. +It may happen that throughout the cluster’s lifecycle, some of the data partitions are lost due to the failure of some primary node and backup nodes that held a copy of the partitions. Such a situation leads to a partial data loss and needs to be addressed according to your use case. For detailed information about partition loss policies, see link:configuring-caches/partition-loss-policy[Partition Loss Policy]. diff --git a/docs/_docs/data-rebalancing.adoc b/docs/_docs/data-rebalancing.adoc index 703adbc..dca2807 100644 --- a/docs/_docs/data-rebalancing.adoc +++ b/docs/_docs/data-rebalancing.adoc @@ -9,9 +9,9 @@ When backups are configured, one of the backup copies of the lost partitions bec [CAUTION] ==== -Data rebalancing is triggered by changes in the link:baseline-topology[Baseline Topology]. +Data rebalancing is triggered by changes in the link:clustering/baseline-topology[Baseline Topology]. In pure in-memory clusters, the default behavior is to start rebalancing immediately when a node leaves or joins the cluster (the baseline topology changes automatically). -In clusters with persistence, the baseline topology has to be changed manually (default behavior), or can be changed automatically when link:baseline-topology#baseline-topology-autoadjustment[automatic baseline adjustment] is enabled. +In clusters with persistence, the baseline topology has to be changed manually (default behavior), or can be changed automatically when link:clustering/baseline-topology#baseline-topology-autoadjustment[automatic baseline adjustment] is enabled. ==== Rebalancing is configured per cache. diff --git a/docs/_docs/data-streaming.adoc b/docs/_docs/data-streaming.adoc index 42530d6..dbbe51d 100644 --- a/docs/_docs/data-streaming.adoc +++ b/docs/_docs/data-streaming.adoc @@ -95,7 +95,7 @@ NOTE: Note that a stream receiver does not put data into the cache automatically The class definitions of the stream receivers to be executed on remote nodes must be available on the nodes. This can be achieved in two ways: * Add the classes to the classpath of the nodes; -* Enable link:peer-class-loading[peer class loading]. +* Enable link:code-deployment/peer-class-loading[peer class loading]. ==== === Stream Transformer diff --git a/docs/_docs/collocated-computations.adoc b/docs/_docs/distributed-computing/collocated-computations.adoc similarity index 98% rename from docs/_docs/collocated-computations.adoc rename to docs/_docs/distributed-computing/collocated-computations.adoc index e04f43a..67f291c 100644 --- a/docs/_docs/collocated-computations.adoc +++ b/docs/_docs/distributed-computing/collocated-computations.adoc @@ -19,7 +19,7 @@ The class definitions of the task to be executed on remote nodes must be availab You can ensure this in two ways: * Add the classes to the classpath of the nodes; -* Enable link:peer-class-loading[peer class loading]. +* Enable link:code-deployment/peer-class-loading[peer class loading]. ==== == Colocating by Key diff --git a/docs/_docs/distributed-computing/distributed-computing.adoc b/docs/_docs/distributed-computing/distributed-computing.adoc index 983a713..0948707 100644 --- a/docs/_docs/distributed-computing/distributed-computing.adoc +++ b/docs/_docs/distributed-computing/distributed-computing.adoc @@ -34,7 +34,7 @@ include::code-snippets/cpp/src/compute_get.cpp[tag=compute-get,indent=0] ---- -- -The compute interface provides methods for distributing different types of tasks over cluster nodes and running link:collocated-computations[colocated computations]. +The compute interface provides methods for distributing different types of tasks over cluster nodes and running link:distributed-computing/collocated-computations[colocated computations]. == Specifying the Set of Nodes for Computations @@ -76,7 +76,7 @@ In order to run tasks on the remote nodes, make sure the class definitions of th You can do this in two ways: - Add the classes to the classpath of the nodes; -- Enable link:peer-class-loading[peer class loading]. +- Enable link:code-deployment/peer-class-loading[peer class loading]. ==== === Executing a Runnable Task @@ -283,7 +283,7 @@ include::code-snippets/cpp/src/compute_acessing_data.cpp[tag=compute-acessing-da Note that the example shown above may not be the most effective way. The reason is that the person object that corresponds to key `1` may be located on a node that is different from the node where the task is executed. -In this case, the object is fetched via network. This can be avoided by link:collocated-computations[colocating the task with the data]. +In this case, the object is fetched via network. This can be avoided by link:distributed-computing/collocated-computations[colocating the task with the data]. [CAUTION] ==== diff --git a/docs/_docs/distributed-computing/load-balancing.adoc b/docs/_docs/distributed-computing/load-balancing.adoc index a357296..285fcf2 100644 --- a/docs/_docs/distributed-computing/load-balancing.adoc +++ b/docs/_docs/distributed-computing/load-balancing.adoc @@ -18,7 +18,7 @@ By default, Ignite uses a round-robin algorithm (`RoundRobinLoadBalancingSpi`), [NOTE] ==== -Load balancing does not apply to link:collocated-computations[colocated computations]. +Load balancing does not apply to link:distributed-computing/collocated-computations[colocated computations]. ==== The load balancing algorithm is controlled by the `IgniteConfiguration.loadBalancingSpi` property. diff --git a/docs/_docs/key-value-api/binary-objects.adoc b/docs/_docs/key-value-api/binary-objects.adoc index 6a53c1d..bce415d 100644 --- a/docs/_docs/key-value-api/binary-objects.adoc +++ b/docs/_docs/key-value-api/binary-objects.adoc @@ -33,7 +33,7 @@ There are several restrictions that are implied by the binary object format impl By default, when you request entries from a cache, they are returned in the deserialized format. To work with the binary format, obtain an instance of the cache using the `withKeepBinary()` method. This instance returns objects in the binary format (when possible). -//and also passes binary objects to link:collocated-computations#entry-processor[entry processors], if any are used. +//and also passes binary objects to link:distributed-computing/collocated-computations#entry-processor[entry processors], if any are used. // and cache interceptors. diff --git a/docs/_docs/key-value-api/continuous-queries.adoc b/docs/_docs/key-value-api/continuous-queries.adoc index 4677670..8f90dbdb 100644 --- a/docs/_docs/key-value-api/continuous-queries.adoc +++ b/docs/_docs/key-value-api/continuous-queries.adoc @@ -106,7 +106,7 @@ In order to use remote filters, make sure the class definitions of the filters a You can do this in two ways: * Add the classes to the classpath of every server node; -* link:peer-class-loading[Enable peer class loading]. +* link:code-deployment/peer-class-loading[Enable peer class loading]. ==== @@ -133,7 +133,7 @@ In order to use transformers, make sure the class definitions of the transformer You can do this in two ways: * Add the classes to the classpath of every server node; -* link:peer-class-loading[Enable peer class loading]. +* link:code-deployment/peer-class-loading[Enable peer class loading]. ==== diff --git a/docs/_docs/memory-configuration/eviction-policies.adoc b/docs/_docs/memory-configuration/eviction-policies.adoc index b20235b..42973d6 100644 --- a/docs/_docs/memory-configuration/eviction-policies.adoc +++ b/docs/_docs/memory-configuration/eviction-policies.adoc @@ -9,7 +9,7 @@ Eviction is used in following cases: * for off-heap memory when link:persistence/native-persistence[Native Persistence] is off; * for off-heap memory when Ignite is used with an link:persistence/external-storage[external storage]; * for link:configuring-caches/on-heap-caching[on-heap caches]; -* for link:near-cache[near caches] if configured. +* for link:configuring-caches/near-cache[near caches] if configured. When Native Persistence is on, a similar process — called _page replacement_ — is used to free up off-heap memory when Ignite cannot allocate a new page. The difference is that the data is not lost (because it is stored in the persistent storage), and therefore you are less concerned about losing data than about efficiency. diff --git a/docs/_docs/cluster-states.adoc b/docs/_docs/monitoring-metrics/cluster-states.adoc similarity index 100% rename from docs/_docs/cluster-states.adoc rename to docs/_docs/monitoring-metrics/cluster-states.adoc diff --git a/docs/_docs/monitoring-metrics/metrics.adoc b/docs/_docs/monitoring-metrics/metrics.adoc index f50c30a..e153e32 100644 --- a/docs/_docs/monitoring-metrics/metrics.adoc +++ b/docs/_docs/monitoring-metrics/metrics.adoc @@ -230,7 +230,7 @@ group=Kernal,name=ClusterMetricsMXBeanImpl | Attribute | Type | Description | Scope | TotalServerNodes| long |The number of server nodes in the cluster.| Global | TotalClientNodes| long |The number of client nodes in the cluster. | Global -| TotalBaselineNodes | long | The number of nodes that are registered in the link:baseline-topology[baseline topology]. When a node goes down, it remains registered in the baseline topology and you need to remote it manually. | Global +| TotalBaselineNodes | long | The number of nodes that are registered in the link:clustering/baseline-topology[baseline topology]. When a node goes down, it remains registered in the baseline topology and you need to remote it manually. | Global | ActiveBaselineNodes | long | The number of nodes that are currently active in the baseline topology. | Global |=== -- diff --git a/docs/_docs/monitoring-metrics/system-views.adoc b/docs/_docs/monitoring-metrics/system-views.adoc index febfd92..a21b55e 100644 --- a/docs/_docs/monitoring-metrics/system-views.adoc +++ b/docs/_docs/monitoring-metrics/system-views.adoc @@ -138,7 +138,7 @@ The CACHE_GROUPS view contains information about the link:configuring-caches/cac |DATA_REGION_NAME | VARCHAR | The name of the link:memory-configuration/data-regions[data region]. |IS_SHARED|BOOLEAN | If this group contains more than one cache. |NODE_FILTER | VARCHAR | The string representation (as returned by the `toString()` method) of the node filter defined for the cache group. -|PARTITION_LOSS_POLICY | VARCHAR | link:partition-loss-policy[Partition loss policy]. +|PARTITION_LOSS_POLICY | VARCHAR | link:configuring-caches/partition-loss-policy[Partition loss policy]. |PARTITIONS_COUNT|INT | The number of partitions. |REBALANCE_DELAY|LONG | link:data-rebalancing#other-properties[Rebalancing delay]. |REBALANCE_MODE | VARCHAR | link:data-rebalancing#configuring-rebalancing-mode[Rebalancing mode]. diff --git a/docs/_docs/platform-cache.adoc b/docs/_docs/net-specific/net-platform-cache.adoc similarity index 92% rename from docs/_docs/platform-cache.adoc rename to docs/_docs/net-specific/net-platform-cache.adoc index fd062d4..35d3f4a 100644 --- a/docs/_docs/platform-cache.adoc +++ b/docs/_docs/net-specific/net-platform-cache.adoc @@ -34,7 +34,7 @@ include::{dotnetCodeFile}[tag=platformCacheConf,indent=0] === Client Nodes -Platform caches on client nodes require a link:near-cache[Near Cache] to be configured, since client nodes do not store data otherwise. The platform cache on a client node keeps the same set of entries as the near cache on that node. the near cache eviction policy effectively applies to the platform cache. +Platform caches on client nodes require a link:configuring-caches/near-cache[Near Cache] to be configured, since client nodes do not store data otherwise. The platform cache on a client node keeps the same set of entries as the near cache on that node. the near cache eviction policy effectively applies to the platform cache. [tabs] -- diff --git a/docs/_docs/perf-and-troubleshooting/handling-exceptions.adoc b/docs/_docs/perf-and-troubleshooting/handling-exceptions.adoc index 834388c..f5f61b2 100644 --- a/docs/_docs/perf-and-troubleshooting/handling-exceptions.adoc +++ b/docs/_docs/perf-and-troubleshooting/handling-exceptions.adoc @@ -15,7 +15,7 @@ Please see the Javadoc _throws_ clause for checked exceptions. | `CacheInvalidStateException` | Thrown when you try to perform an operation on a cache in which some partitions have been lost. Depending on the partition loss policy configured for the cache, this exception is thrown either on read and/or write operations. -See link:partition-loss-policy[Partition Loss Policy] for details. +See link:configuring-caches/partition-loss-policy[Partition Loss Policy] for details. | Reset lost partitions. You may want to restore the data by returning the nodes that caused the partition loss to the cluster. | Yes diff --git a/docs/_docs/restapi.adoc b/docs/_docs/restapi.adoc index c3345c8..bc8d4fe 100644 --- a/docs/_docs/restapi.adoc +++ b/docs/_docs/restapi.adoc @@ -394,7 +394,7 @@ http://host:port/ignite?cmd=version ---- === Cluster State -Returns the current link:cluster-states[state of the cluster]. +Returns the current link:monitoring-metrics/cluster-states[state of the cluster]. *Request:*:: + @@ -420,7 +420,7 @@ Returns `true` if the cluster is active. Returns `false` if the cluster in inact === Change Cluster State -The `setstate` command changes the link:cluster-states[cluster state]. +The `setstate` command changes the link:monitoring-metrics/cluster-states[cluster state]. *Request:*:: + diff --git a/docs/_docs/services/services.adoc b/docs/_docs/services/services.adoc index 24f3dde..c5f960a 100644 --- a/docs/_docs/services/services.adoc +++ b/docs/_docs/services/services.adoc @@ -235,7 +235,7 @@ tab:C++[] == Re-deploying Services -If you want to update the implementation of a service without stopping the cluster, you can do it if you use the Ignite's link:deploying-user-code[DeploymentSPI configuration]. +If you want to update the implementation of a service without stopping the cluster, you can do it if you use the Ignite's link:code-deployment/deploying-user-code[DeploymentSPI configuration]. Use the following procedure to redeploy the service: diff --git a/docs/_docs/setup.adoc b/docs/_docs/setup.adoc index e13237c..158a4ee 100644 --- a/docs/_docs/setup.adoc +++ b/docs/_docs/setup.adoc @@ -1,5 +1,16 @@ = Setting Up +[NOTE] +==== +[discrete] +=== Configuring .NET, Python, Node.JS and other programming languages + +* .NET developers: refer to the link:net-specific/net-configuration-options[Ignite.NET Configuration] section +* Developers of Python, Node.JS, and other programming languages: use this page to configure your +Java-powered Ignite cluster and link:thin-clients/getting-started-with-thin-clients[thin clients] section to set up +your language-specific applications that will be working with the cluster. +==== + == System Requirements Ignite was tested on: diff --git a/docs/_docs/starting-nodes.adoc b/docs/_docs/starting-nodes.adoc index d0c85f9..c5e634b 100644 --- a/docs/_docs/starting-nodes.adoc +++ b/docs/_docs/starting-nodes.adoc @@ -2,10 +2,11 @@ This chapter explains how to start server and client nodes. -There are two types of nodes: _server nodes_ and _client nodes_. -Server nodes participate in caching, compute execution, stream processing, etc. -Client nodes provide the ability to connect to the servers remotely. -Client nodes provide the whole set of Ignite APIs, including near caching, transactions, compute, streaming, services, etc. from the client side. +There are two types of nodes: _server nodes_ and _client nodes_. The client nodes are also referred as _thick clients_ to +distinguish from the link:thin-clients/getting-started-with-thin-clients[thin clients]. Server nodes participate in caching, compute execution, +stream processing, etc. Thick clients provide the ability to connect to the servers remotely. +The client nodes provide the whole set of Ignite APIs, including near caching, transactions, compute, streaming, +services, etc. from the client side. By default, all Ignite nodes are started as server nodes, and you should explicitly enable the client mode. @@ -112,8 +113,8 @@ Non-graceful shutdowns should be used as a last resort when the node is not resp A graceful shutdown allows the node to finish critical operations and correctly complete its lifecycle. The proper procedure to perform a graceful shutdown is as follows: -//is to use one of the following ways to stop the node and remove it from the link:baseline-topology[baseline topology]: -//to remove the node from the link:baseline-topology[baseline topology] and +//is to use one of the following ways to stop the node and remove it from the link:clustering/baseline-topology[baseline topology]: +//to remove the node from the link:clustering/baseline-topology[baseline topology] and . Stop the node using one of the following methods: //tag::stop-commands[] @@ -122,7 +123,7 @@ The proper procedure to perform a graceful shutdown is as follows: * send a user interrupt signal. Ignite uses a JVM shutdown hook to execute custom logic before the JVM stops. If you start the node by running `ignite.sh` and don't detach it from the terminal, you can stop the node by hitting `Ctrl+C`. //end::stop-commands[] -. Remove the node from the link:baseline-topology[baseline topology]. This step may not be necessary if link:baseline-topology#baseline-topology-autoadjustment[baseline auto-adjustment] is enabled. +. Remove the node from the link:clustering/baseline-topology[baseline topology]. This step may not be necessary if link:clustering/baseline-topology#baseline-topology-autoadjustment[baseline auto-adjustment] is enabled. @@ -165,7 +166,7 @@ To enable partition loss prevention, set the `IGNITE_WAIT_FOR_BACKUPS_ON_SHUTDOW CAUTION: If you have a cache without partition backups and you stop a node (even with this property set), you will lose the portion of the cache that was kept on this node. -//The behavior of the node depend on whether the baseline topology is configured to be link:baseline-topology#baseline-topology-autoadjustment[adjusted automatically]. +//The behavior of the node depend on whether the baseline topology is configured to be link:clustering/baseline-topology#baseline-topology-autoadjustment[adjusted automatically]. When this property is set, the last node in the cluster will not stop gracefully. You will have to terminate the process by sending the `kill -9` signal. diff --git a/docs/_docs/thin-clients/python-thin-client.adoc b/docs/_docs/thin-clients/python-thin-client.adoc index 07c067f..7803fef 100644 --- a/docs/_docs/thin-clients/python-thin-client.adoc +++ b/docs/_docs/thin-clients/python-thin-client.adoc @@ -266,7 +266,7 @@ a|Rebalancing mode: |PROP_PARTITION_LOSS_POLICY |int -a|link:partition-loss-policy[Partition loss policy]: +a|link:configuring-caches/partition-loss-policy[Partition loss policy]: - READ_ONLY_SAFE=0, - READ_ONLY_ALL=1, diff --git a/docs/_docs/tools/control-script.adoc b/docs/_docs/tools/control-script.adoc index ecab54f..a994014 100644 --- a/docs/_docs/tools/control-script.adoc +++ b/docs/_docs/tools/control-script.adoc @@ -51,12 +51,12 @@ If you want to connect to a node that is running on a remove machine, specify th == Activation, Deactivation and Topology Management -You can use the control script to activate or deactivate your cluster, and manage the link:baseline-topology[Baseline Topology]. +You can use the control script to activate or deactivate your cluster, and manage the link:clustering/baseline-topology[Baseline Topology]. === Getting Cluster State -The cluster can be in one of the three states: active, read only, or inactive. Refer to link:cluster-states[Cluster States] for details. +The cluster can be in one of the three states: active, read only, or inactive. Refer to link:monitoring-metrics/cluster-states[Cluster States] for details. To get the state of the cluster, run the following command: @@ -241,7 +241,7 @@ control.bat --baseline version _topologyVersion_ [--yes] === Enabling Baseline Topology Autoadjustment -link:baseline-topology#baseline-topology-autoadjustment[Baseline topology autoadjustment] refers to automatic update of baseline topology after the topology has been stable for a specific amount of time. +link:clustering/baseline-topology#baseline-topology-autoadjustment[Baseline topology autoadjustment] refers to automatic update of baseline topology after the topology has been stable for a specific amount of time. For in-memory clusters, autoadjustment is enabled by default with the timeout set to 0. It means that baseline topology changes immediately after server nodes join or leave the cluster. For clusters with persistence, the automatic baseline adjustment is disabled by default. @@ -410,7 +410,7 @@ control.sh|bat --cache list counter-.* --seq == Resetting Lost Partitions You can use the control script to reset lost partitions for specific caches. -Refer to link:partition-loss-policy[Partition Loss Policy] for details. +Refer to link:configuring-caches/partition-loss-policy[Partition Loss Policy] for details. [source, shell] ---- diff --git a/docs/_docs/transactions/mvcc.adoc b/docs/_docs/transactions/mvcc.adoc index 55fcd28..da4b4f2 100644 --- a/docs/_docs/transactions/mvcc.adoc +++ b/docs/_docs/transactions/mvcc.adoc @@ -169,7 +169,7 @@ If you use link:key-value-api/continuous-queries[Continuous Queries] with an MVC === Other Limitations The following features are not supported for the MVCC-enabled caches. These limitations may be addressed in future releases. -* link:near-cache[Near Caches] +* link:configuring-caches/near-cache[Near Caches] * link:configuring-caches/expiry-policies[Expiry Policies] * link:events/listening-to-events[Events] * link:{javadoc_base_url}/org/apache/ignite/cache/CacheInterceptor.html[Cache Interceptors] diff --git a/docs/_docs/understanding-configuration.adoc b/docs/_docs/understanding-configuration.adoc index 4f4c372..479db43 100644 --- a/docs/_docs/understanding-configuration.adoc +++ b/docs/_docs/understanding-configuration.adoc @@ -1,7 +1,19 @@ = Understanding Configuration -This chapter explains different ways of setting configuration parameters in an Ignite cluster. +This chapter explains different ways of setting configuration parameters in an Ignite cluster. The chapter covers the most +ubiquitous approaches for Java and C++ applications. + +[NOTE] +==== +[discrete] +=== Configuring .NET, Python, Node.JS and other programming languages + +* .NET developers: refer to the link:net-specific/net-configuration-options[Ignite.NET Configuration] section +* Developers of Python, Node.JS, and other programming languages: use this page to configure your +Java-powered Ignite cluster and link:thin-clients/getting-started-with-thin-clients[thin clients] section to set up +your language-specific applications that will be working with the cluster. +==== == Overview