Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

IGNITE-22136 Updated AI3 doc with new features #3678

Merged
merged 1 commit into from
May 10, 2024
Merged

IGNITE-22136 Updated AI3 doc with new features #3678

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
171 changes: 114 additions & 57 deletions docs/_data/toc.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,82 +14,139 @@
# limitations under the License.
- title: About Apache Ignite 3
url: index
- title: Getting Started Guide
url: quick-start/getting-started-guide
- title: Installation
url: installation
url: installation/installing-using-zip
items:
- title: Installing Using ZIP Archive
url: installation/installing-using-zip
- title: Installing Using Docker
url: installation/installing-using-docker
- title: Installing DEB or RPM package
url: installation/deb-rpm
- title: Ignite CLI Tool
- title: Installing Docker
url: installation/installing-using-docker
- title: Getting Started
url: quick-start/getting-started-guide
- title: Embedded Mode
url: quick-start/embedded-mode
- title: GridGain CLI Tool
url: ignite-cli-tool
- title: Working with SQL
- title: Developers Guide
url: developers-guide/table-api
items:
- title: Introduction
url: sql/calcite-based-sql-engine
- title: JDBC Driver
url: sql/jdbc-driver
- title: ODBC Driver
url: sql/odbc/odbc-driver
- title: Table API
url: developers-guide/table-api
- title: Clients
url: developers-guide/clients/overview
items:
- title: Overview
url: developers-guide/clients/overview
- title: Java Clients
url: developers-guide/clients/java
- title: .NET Clients
url: developers-guide/clients/dotnet
- title: C++ Clients
url: developers-guide/clients/cpp
- title: .NET LINQ Queries
url: developers-guide/clients/linq
- title: Working with SQL
url: developers-guide/sql/calcite-based-sql-engine
items:
- title: Introduction
url: developers-guide/sql/calcite-based-sql-engine
- title: JDBC Driver
url: developers-guide/sql/jdbc-driver
- title: System Views
url: developers-guide/sql/system-views
- title: ODBC Driver
url: sql/odbc/odbc-driver
- title: Connection String
url: sql/odbc/connection-string
- title: Querying and Modifying Data
url: sql/odbc/querying-modifying-data
- title: Java API
url: sql/java
url: developers-guide/sql/odbc/odbc-driver
items:
- title: ODBC Driver
url: developers-guide/sql/odbc/odbc-driver
- title: Connection String
url: developers-guide/sql/odbc/connection-string
- title: Querying and Modifying Data
url: developers-guide/sql/odbc/querying-modifying-data
- title: Standard Conformance
url: developers-guide/sql/odbc/specification
- title: Tables from Java Classes
url: developers-guide/java-to-tables
- title: Distributed Computing
url: developers-guide/compute/compute
- title: Transactions
url: developers-guide/transactions
- title: Data Streaming
url: developers-guide/data-streamer
- title: Code Deployment
url: developers-guide/code-deployment/code-deployment
- title: Cache Storage
url: developers-guide/cache
- title: REST API
url: developers-guide/rest/rest-api
items:
- title: Overview
url: developers-guide/rest/rest-api
- title: Administrator’s Guide
url: administrators-guide/config/config
items:
- title: GridGain Configuration
url: administrators-guide/config/config
items:
- title: Node Configuration Parameters
url: administrators-guide/config/node-config
- title: Cluster Configuration Parameters
url: administrators-guide/config/cluster-config
- title: Storage Configuration
url: administrators-guide/config/storage/persistent
items:
- title: Native Persistent Storage
url: administrators-guide/config/storage/persistent
- title: RocksDB Persistent Storage
url: administrators-guide/config/storage/rocksdb
- title: Volatile Storage
url: administrators-guide/config/storage/volatile
- title: Table Configuration
url: administrators-guide/config/storage/table-configuration
- title: Memory Quotas Configuration
url: administrators-guide/config/memory-quotas
- title: Security and Authentication
url: administrators-guide/security/ssl-tls
items:
- title: SSL/TLS
url: administrators-guide/security/ssl-tls
- title: Authentication
url: administrators-guide/security/authentication
- title: JWT Authentication
url: administrators-guide/security/jwt
- title: User Permissions and Roles
url: administrators-guide/security/permissions
- title: Metrics and Monitoring
url: administrators-guide/metrics/configuring-metrics
items:
- title: Configuring Metrics
url: administrators-guide/metrics/configuring-metrics
- title: Metrics List
url: administrators-guide/metrics/metrics-list
- title: Handling Exceptions
url: administrators-guide/handling-exceptions
- title: SQL Reference
url: sql-reference/ddl
items:
- 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: Distribution Zones
url: sql-reference/distribution-zones
- title: Supported Operators and Functions
url: sql-reference/operators-and-functions
- title: REST
items:
- title: Overview
url: rest/rest-api
- title: Reference
url: rest/reference
- title: Clients & Drivers
items:
- title: Ignite Clients
url: thin-clients/index
- title: .NET LINQ Queries
url: thin-clients/linq
- title: Distributed Computing
url: compute/compute
- title: Data Region Configuration
url: config/data-region
- title: Storage Configuration
url: storage/persistent
items:
- title: Native Persistent Storage
url: storage/persistent
- title: RocksDB Persistent Storage
url: storage/rocksdb
- title: Volatile Storage
url: storage/volatile
- title: Binary Client Protocol
url: binary-protocol
- title: SSL/TLS
url: ssl-tls
- title: Data Rebalancing
url: rebalance
- title: Performing Transactions
url: transactions/performing-transactions
- title: Table Views
url: table-views
- title: Handling Exceptions
url: handling-exceptions
- title: Grammar Reference
url: sql-reference/grammar-reference
- title: Data Types
url: sql-reference/data-types
- title: SQL Performance Tuning
url: sql-tuning
- title: General Configuration Tips
url: general-tips
- title: Glossary
url: glossary/glossary
52 changes: 52 additions & 0 deletions docs/_docs/administrators-guide/config/cli-config.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
// 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.
== Config Parameters

----
ignite.jdbc.key-store.path=
ignite.cluster-endpoint-url=http://127.0.1.1:10300
ignite.jdbc.client-auth=
ignite.rest.key-store.password=
ignite.jdbc.key-store.password=
ignite.rest.trust-store.path=
ignite.jdbc.trust-store.password=
ignite.auth.basic.username=
ignite.jdbc-url=jdbc:ignite:thin://127.0.0.1:10800
ignite.rest.key-store.path=
ignite.rest.trust-store.password=
ignite.jdbc.trust-store.path=
ignite.auth.basic.password=
----

[cols="1,1,3",opts="header", stripes=none]
|======
|Property|Default|Description

|ignite.jdbc.key-store.path||Path to the JDBC keystore file.
|ignite.cluster-endpoint-url|http://127.0.1.1:10300|
|ignite.jdbc.client-auth||If JDBC client authorization is enabled in CLI.
|ignite.rest.key-store.password||
|ignite.jdbc.key-store.password||
|ignite.rest.trust-store.path||
|ignite.jdbc.trust-store.password||
|ignite.auth.basic.username||
|ignite.jdbc-url|jdbc:ignite:thin://127.0.0.1:10800|
|ignite.rest.key-store.path||
|ignite.rest.trust-store.password||
|ignite.jdbc.trust-store.path||
|ignite.auth.basic.password||
|======

== Configuration Profiles
136 changes: 136 additions & 0 deletions docs/_docs/administrators-guide/config/cluster-config.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
// 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.
= Cluster Configuration Parameters

Ignite 3 cluster configuration is shared across the whole cluster. Regardless of which node you apply the configuration on, it will be propogated to all nodes in the cluster.

== Garbage Collection

[source, json]
----
"gc" : {
"batchSize" : 5,
"lowWatermark" : {
"dataAvailabilityTime" : 600000,
"updateFrequency" : 300000
},
"threads" : 16
},
----

[cols="1,1,3",opts="header", stripes=none]
|======
|Property|Default|Description
|batchSize|5|Garbage collection batch size.
|lowWatermark.dataAvailabilityTime|600000|The duration outdated versions are available for.
|lowWatermark.updateFrequency|300000|The frequency of low watermark updates.
|threads|16|The number of threads used by garbage collector.
|======

== Metastorage Configuration

[source, json]
----
"metaStorage" : {
"idleSyncTimeInterval" : 500
},
----

[cols="1,1,3",opts="header", stripes=none]
|======
|Property|Default|Description
|idleSyncTimeInterval|500|How long it takes to synchronize metastorage.

|======

== Metrics Configuration

[source, json]
----
"metrics" : {
"exporters" : [ ]
},
----

[cols="1,1,3",opts="header", stripes=none]
|======
|Property|Default|Description
|exporters||The list of metric exporters currently used. For more information, see link:/metrics/configuring-metrics.adoc[Configuring Metrics].
|======

== Replication Configuration

[source, json]
----
"replication" : {
"idleSafeTimePropagationDuration" : 1000
},
----

[cols="1,1,3",opts="header", stripes=none]
|======
|Property|Default|Description
|idleSafeTimePropagationDuration|1000| How long it takes for replication of data to be replicated to other nodes in cluster.

|======

== Schema Sync Configuration

[source, json]
----
"schemaSync" : {
"delayDuration" : 1000
},
----

[cols="1,1,3",opts="header", stripes=none]
|======
|Property|Default|Description
|delayDuration|1000|The delay between schema being updated and synchronized across the cluster.

|======

== SQL Configuration

[source, json]
----
"sql" : {
"statementMemoryQuota" : "10K"
},
----

[cols="1,1,3",opts="header", stripes=none]
|======
|Property|Default|Description
|statementMemoryQuota|10K|The amount of memory that can be used in by a single SQL statement.

|======

== Transactions Configuration

[source, json]
----
"transaction" : {
"abandonedCheckTs" : 5000
}
}
----


[cols="1,1,3",opts="header", stripes=none]
|======
|Property|Default|Description
|abandonedCheckTs|5000|The amount of time after which the transaction is considered abandoned.
|======