Skip to content

Commit

Permalink
Merge pull request #30 from skysqlinc/fix-links-2
Browse files Browse the repository at this point in the history
Major cleanup and reformatting of pages.
  • Loading branch information
nachiketb committed Jul 18, 2024
2 parents 0e75912 + 2f5b394 commit c0e1fe9
Show file tree
Hide file tree
Showing 51 changed files with 702 additions and 776 deletions.
2 changes: 1 addition & 1 deletion docs/Autonomously scale Compute, Storage/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Auto-scale of storage enables expansion of capacity based on usage.
Autonomous features can be enabled at time of [service launch](<../Portal features/Launch page/>).
Autonomous features can be enabled or disabled after launch.

![https://mariadb.com/docs/_images/screenshots/services-tx-xpand-autonomous-dialog.png](https://mariadb.com/docs/_images/screenshots/services-tx-xpand-autonomous-dialog.png)
![autonomous.png](autonomous.png)

## Enable Auto-Scaling of Nodes

Expand Down
10 changes: 5 additions & 5 deletions docs/Autonomously scale Compute, Storage/Uptime SLA.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Uptime SLA

MariaDB SkySQL customers should assess the availability requirements of their application and choose an appropriate service tier to meet their objectives. MariaDB SkySQL customers are on the Foundation Tier unless they have specifically purchased and paid for Power Tier service.
SkySQL customers should assess the availability requirements of their application and choose an appropriate service tier to meet their objectives. SkySQL customers are on the Foundation Tier unless they have specifically purchased and paid for Power Tier service.

## **Performance Standard**

Expand Down Expand Up @@ -57,23 +57,23 @@ A customer will forfeit their right to receive a [Service Credit](https://maria

- **Underlying infrastructure**

Impact to service availability caused by availability or performance of cloud services used to operate MariaDB SkySQL is excluded. This includes any such outages in Amazon Web Services (AWS) and Amazon Elastic Kubernetes Service (EKS), and Google Cloud Platform (GCP) and Google Kubernetes Engine (GKE).
Impact to service availability caused by availability or performance of cloud services used to operate SkySQL is excluded. This includes any such outages in Amazon Web Services (AWS) and Amazon Elastic Kubernetes Service (EKS), and Google Cloud Platform (GCP) and Google Kubernetes Engine (GKE).

- **Network interruption**

Impact to service availability caused by blocking of network traffic by ISPs, network providers, governments, or third parties is excluded.

- **External factors**

Impact to your use of service based on factors outside MariaDB SkySQL are excluded. This includes periods of downtime for your applications.
Impact to your use of service based on factors outside SkySQL are excluded. This includes periods of downtime for your applications.

- **Uncorroborated impacts**

Only impacts to service availability detected at [point of measurement](https://mariadb.com/docs/skysql-dbaas/service-management/nr-sla/#Service_Downtime) are subject when determining the uptime percentage. Service availability impacts measured through any other means, such as application instrumentation, are excluded except as also measured as [Service Downtime](https://mariadb.com/docs/skysql-dbaas/service-management/nr-sla/#Service_Downtime) by MariaDB.

- **Portal access**

Impact to your ability to access or use the MariaDB SkySQL portal, an interface provided to manage services, is excluded. This includes any component and content linked from the MariaDB SkySQL portal, including Documentation, the Customer Support portal, Monitoring, and Workload Analysis. These components operate independently from database services and do not impact database availability.
Impact to your ability to access or use the SkySQL portal, an interface provided to manage services, is excluded. This includes any component and content linked from the SkySQL portal, including Documentation, the Customer Support portal, Monitoring, and Workload Analysis. These components operate independently from database services and do not impact database availability.

- **Resource usage**

Expand All @@ -85,7 +85,7 @@ A customer will forfeit their right to receive a [Service Credit](https://maria

- **Non-paying customers**

The [Performance Standard](https://mariadb.com/docs/skysql-dbaas/service-management/nr-sla/#Performance_Standard) applies only to paying MariaDB SkySQL customers who are paid-in-full. All other MariaDB SkySQL customers, including those not paid-in-full and those customers participating in a free or credited service trial, are excluded.
The [Performance Standard](https://mariadb.com/docs/skysql-dbaas/service-management/nr-sla/#Performance_Standard) applies only to paying SkySQL customers who are paid-in-full. All other SkySQL customers, including those not paid-in-full and those customers participating in a free or credited service trial, are excluded.

- **Customer-directed maintenance**

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/Backup and Restore/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ Binlogs record database changes (data modifications, table structure changes) in

#### BinaryLog Backup Examples

- [Examples](BinaryLog Backup Examples.md)
- [Examples](<./Binarylog Backup Examples.md>)

### **Additional Backup Options (with Examples)**

Expand Down
26 changes: 8 additions & 18 deletions docs/Billing and Power Tier/Billing.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Billing

Billing is associated with a [MariaDB ID](https://mariadb.com/docs/skysql-dbaas/working/nr-mariadb-id/).
Billing is associated with a SkySQL ID.

For pricing information see "[Pricing](https://mariadb.com/docs/skysql-previous-release/features-and-concepts/pricing/)" .
For pricing information see "[Pricing](<./Pricing.md>)" .

## **Usage Information**

From the [Portal](https://mariadb.com/docs/skysql-dbaas/working/nr-portal/), you can access a current billing and usage summary:
From the [Portal](https://app.skysql.com/dashboard), you can access a current billing and usage summary:

1. Log in to the [Portal](https://mariadb.com/docs/skysql-dbaas/working/nr-portal/).
1. Log in to the [Portal](https://app.skysql.com/dashboard).
2. Click your name in the upper-right corner of the interface, then select "Billing" from the menu.
3. The "Current Usage" tab (the default) shows current billing and usage summary.

Expand All @@ -18,24 +18,14 @@ Usage information can be shown by service or by resource.

Click the resource name or service name to expand the view.

![https://mariadb.com/docs/_images/screenshots/services-tx-xpand-billing-usage.png](https://mariadb.com/docs/_images/screenshots/services-tx-xpand-billing-usage.png)
![current-usage.png](current-usage.png)

*Billing - Usage*

https://skysql.mariadb.com/billings/usage
*Billing - Current Usage*

## **Billing History & Invoices**

From the [Portal](https://mariadb.com/docs/skysql-dbaas/working/nr-portal/), you can access prior invoices:
From the [Portal](https://app.skysql.com/dashboard), you can access prior invoices:

1. Log in to the [Portal](https://mariadb.com/docs/skysql-dbaas/working/nr-portal/).
1. Log in to the [Portal](https://app.skysql.com/dashboard).
2. Click your name in the upper-right corner of the interface, then select "Billing" from the menu.
3. Click the "Billing History" tab to show available invoices.
- Remittance customers should contact their billing administrator for billing questions.

![https://mariadb.com/docs/_images/screenshots/services-tx-xpand-billing-history.png](https://mariadb.com/docs/_images/screenshots/services-tx-xpand-billing-history.png)

*Billing - Billing History*

https://skysql.mariadb.com/billings/history

43 changes: 43 additions & 0 deletions docs/Billing and Power Tier/Maintenance Windows.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Maintenance Windows

Maintenance windows are a scheduled period of time when hardware, network, software, or configuration changes can be applied, and processes can be restarted.

For Foundation Tier customers, maintenance windows are predefined by region.

For Power Tier customers, maintenance windows are customer-selected.

Notice is provided to customers in advance of maintenance. SkyDBA customers are asked to confirm maintenance prior to scheduled start.

## View Current Maintenance Window

For Foundation Tier, to view the maintenance widown, Go to "Your services" and then "Details".

On Power Tier, to show the current maintenance window for a service:

1. Go to "Your services" page (top choice in left navigation).

2. Click the ">" to the left of the desired service.

3. The current maintenance window is shown in the "Customization" section.

## Choose Maintenance Window

A maintenance window selection applies to all services within a region.

For Power Tier customers, maintenance windows are customer-selected:

- A menu of supported maintenance windows is presented at time of service launch.

- Maintenance windows may be changed after service launch, once a service reaches "Healthy" state.

Maintenance windows can be updated at time of service launch, or on-demand:

1. Go to "Your services" page (top choice in left navigation).

2. Click the ">" to the left of the desired service.

3. The current maintenance window is shown in the "Customization" section.

4. Click on the triangle at the right of the "Maintenance window" to see a drop down display of available maintenance windows.

5. Select the desired maintenance window and click on the "Save" button. This change will be applied to all services in the region.
25 changes: 25 additions & 0 deletions docs/Billing and Power Tier/Maxscale Redundancy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# MaxScale Redundancy

MariaDB MaxScale serves as the load balancer in certain SkySQL topologies.

SkySQL supports MaxScale Redundancy as an option at time of launch:

- This feature is not enabled by default. By default, topologies that use MaxScale contain only one MaxScale node.

- When MaxScale Redundancy is selected, MaxScale nodes are deployed in a highly available (HA) active-active configuration behind round robin load balancing.

- When MaxScale Redundancy is enabled, MaxScale instance size can be selected.

- MaxScale Redundancy is available to Power Tier customers.

## Compatibility

- Replicated Transactions

## Enable MaxScale Redundancy

1. Launch a SkySQL service:

- Check the "Enable MaxScale Redundancy" checkbox.

- Choose the [MaxScale instance size](<../Reference Guide/Instance Size Choices.md>)
35 changes: 35 additions & 0 deletions docs/Billing and Power Tier/Pricing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Pricing

SkySQL pricing information is shown at time of service launch.

Pricing shown within the SkySQL interface is an estimate of the cost of using SkySQL services based on your specified usage parameters. Pricing information is shown at time of service launch and subsequently as estimated charges.

The cost shown is not a quote and does not guarantee the cost for your actual use of SkySQL services.

## Estimated Pricing

The cost estimate may vary from your actual costs for several reasons, including:

- **Actual usage**: Your actual cost will be based on your actual use of the services, not the estimate.

- **Region**: The prices for SkySQL services may vary between regions. Using a different region than the one selected may affect the results.

- **Price changes**: On-demand pricing for most services may change over time. If you buy services on-demand, your bill may be less or more than estimated based on the current on-demand rates.

- **Taxes**: The estimate does not include any taxes that may be applied to your purchase of the services.

- **Time frame assumptions**: On-demand monthly pricing assumes that your instance or node runs for a 730 hour month. The estimate does not account for leap years, which add one additional day (24 hours).

- **Promotional credits and discounts**: The estimate does not account for promotional credits or other discounts.

- **Monthly billing period**: MariaDB bills on a monthly basis. If your utilization starts mid-month, you will only see a portion of an actual month's full costs on your invoice.

- **Rounding**: Estimated fees include mathematical rounding of pricing data.

- **Scale fabric**: Scale fabric costs represent the additional network, host, and backup infrastructure needed to support multi-node topologies. In addition to multi-node topologies, this cost also applies to the Distributed Transactions topology when deployed with 1 Xpand node, since infrastructure is present to support scale-up to a multi-node configuration.

- **Previous services**: The estimate is only for the service being launched and does not account for other current or previous charges to the SkySQL account.

- **Cross-Region Replicas**: The estimate does not include cross-region replicas.

- **Currency**: Estimates are provided in either US dollars or Euros depending on your account address country. Your actual cost will be based on US dollar pricing with a conversion to Euros depending on your account address country.
17 changes: 7 additions & 10 deletions docs/Billing and Power Tier/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,17 @@ Power Tier is a premium service offering who have the most critical requirements

## **Upgrade to Power Tier**

By default, any new signed up users are in the “Foundation Tier”. To upgrade to Power Tier, simply click the ‘Upgrade’ button - SkySQL support will contact you and start the upgrade process. You can also directly reach out to [SkySQL Support](https://mariadb.com/docs/skysql-previous-release/service-management/support/).
By default, any new signed up users are in the “Foundation Tier”. To upgrade to Power Tier, simply click the ‘Upgrade’ button - SkySQL support will contact you and start the upgrade process. You can also directly reach out to [SkySQL Support](<../Support.md>).

## **Features**

Features available to SkySQL Power Tier customers include:

- [Enhanced Service Level Agreement (SLA)](https://mariadb.com/docs/skysql-previous-release/features-and-concepts/service-availability/)
- [Extended Range of Instance Sizes](https://mariadb.com/docs/skysql-previous-release/features-and-concepts/selections/instance-sizes/)
- [Custom Instance Sizes](https://mariadb.com/docs/skysql-previous-release/service-management/options/custom-instance-sizes/)
- [Choice of Maintenance Window](https://mariadb.com/docs/skysql-previous-release/features-and-concepts/selections/maintenance-window/)
- [MaxScale Redundancy](https://mariadb.com/docs/skysql-previous-release/service-management/options/maxscale-redundancy/)
- [Custom Configuration](https://mariadb.com/docs/skysql-previous-release/service-management/options/custom-configuration/)
- Choice between [Enterprise and Platinum Support Plans](https://mariadb.com/docs/skysql-previous-release/features-and-concepts/support/)
- [AWS PrivateLink](https://mariadb.com/docs/skysql-previous-release/service-management/options/aws-privatelink/) and [GCP VPC Peering](https://mariadb.com/docs/skysql-previous-release/service-management/options/vpc-peering/) available
- [Enhanced Service Level Agreement (SLA)](https://skysql.com/sla/)
- [Extended Range of Instance Sizes](<../Reference Guide/Instance Size Choices.md>)
- [Choice of Maintenance Window](<./Maintenance Windows.md>)
- [MaxScale Redundancy](<./Maxscale Redundancy.md>)
- Choice of [Support Plans](https://skysql.com/support-policy/)
- Point-in-time recovery
- See all [Options](https://mariadb.com/docs/skysql-previous-release/service-management/options/) which augment the default SkySQL service experience
- See all [Options](https://skysql.com/support-policy/) which augment the default SkySQL service experience

Binary file added docs/Billing and Power Tier/current-usage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 4 additions & 22 deletions docs/Connecting to Sky DBs/Connect from Java App.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,12 @@

MariaDB Connector/J enables Java applications to connect to SkySQL using a native MariaDB connector.

# Download the connector ..

| Version | Latest Release | Latest Release Date | Maturity |
| --- | --- | --- | --- |
| MariaDB Connector/J 3.1 | https://mariadb.com/docs/server/release-notes/mariadb-connector-j-3-1/3-1-4/ | 2023-05-01 | General Availability |
| MariaDB Connector/J 3.0 | https://mariadb.com/docs/server/release-notes/mariadb-connector-j-3-0/3-0-10/ | 2023-01-11 | General Availability |
| MariaDB Connector/J 2.7 | https://mariadb.com/docs/server/release-notes/mariadb-connector-j-2-7/2-7-9/ | 2023-03-22 | General Availability |
| MariaDB Connector/J 1.8 | MariaDB Connector/J 1.8.0 | 2019-02-11 | GA |

# Install MariaDB Connector/J via JAR

To download the JAR file manually:

1. Go to the [MariaDB Connector/J download page](https://mariadb.com/downloads/connectors/connectors-data-access/java8-connector/)
2. Within the "Product" dropdown, choose the "Java 8 connector" or "Java 7 connector".
2. Within the "Product" dropdown, choose the "Java 8+ connector".
3. In the "Version" dropdown, choose the desired version.
4. Click the "Download" button to download the JAR file.
5. When the JAR file finishes downloading, place it into the relevant directory on your system.
Expand All @@ -32,18 +23,18 @@ To use Maven to install MariaDB Connector/J, add the dependency to your `pom.xm
<dependency>
<groupId>org.mariadb.jdbc</groupId>
<artifactId>mariadb-java-client</artifactId>
<version>3.0.10</version>
<version>3.4.1</version>
</dependency>
```

For additional information on available releases, see the "[Release Notes for MariaDB Connector/J](https://mariadb.com/docs/server/release-notes/mariadb-connector-j-3-1/)".
For additional information on available releases, see the "[Release Notes for MariaDB Connector/J](https://mariadb.com/kb/en/mariadb-connector-j-release-notes/)".

Depending on the features you plan to use, you may need to add some additional dependencies to `pom.xml`.

If you downloaded the connector JAR, place it on your CLASSPATH

```bash
export CLASSPATH="/path/to/application:/path/to/mariadb-java-client-3.0.10.jar"
export CLASSPATH="/path/to/application:/path/to/mariadb-java-client-3.4.1.jar"
```

### **Connector/J 3.0**
Expand Down Expand Up @@ -111,12 +102,3 @@ public class App {
}
}
```

| Connector | MariaDB Connector/J |
| --- | --- |
| Supported Versions | https://mariadb.com/docs/server/release-notes/mariadb-connector-j-3-1/https://mariadb.com/docs/server/release-notes/mariadb-connector-j-3-0/https://mariadb.com/docs/server/release-notes/mariadb-connector-j-2-7/MariaDB Connector/J 1.8 |
| Programming Language | Java |
| Programming Language Version | Java 17, Java 11, Java 8 (Connector/J 3.1)Java 17, Java 11, Java 8 (Connector/J 3.0)Java 17, Java 11, Java 8 (Connector/J 2.7)Java 7 (Connector/J 1.8) |
| API | JDBC 4.2 (Connector/J 3.1)JDBC 4.2 (Connector/J 3.0)JDBC 4.2 (Connector/J 2.7)JDBC 4.1 (Connector/J 1.8) |
| Supports TLS | Yes |
| License | GNU Lesser General Public License v2.1 |
4 changes: 2 additions & 2 deletions docs/Connecting to Sky DBs/Connect from MongoDB clients.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ For detailed information on supported commands, see "[NoSQL Protocol Module](htt

# Enable Support for NoSQL

1. When [launching](https://mariadb.com/docs/skysql-dbaas/service-management/nr-launch/) Enterprise Server With Replica(s), after defining the service name, expand the "Additional options" section.
1. When [launching](<../Portal features/Launch page.md>) Enterprise Server With Replica(s), after defining the service name, expand the "Additional options" section.
2. Check the "Enable support for NoSQL" checkbox.

# Available Clients
Expand All @@ -26,6 +26,6 @@ From the Dashboard, the details needed to connect to your SkySQL service can be

The "NoSQL port" is the TCP port used to connect to the NoSQL interface.

The [firewall](https://mariadb.com/docs/skysql-dbaas/security/nr-firewall/) must be configured to allowlist the client's IP address or netblock before connections can occur.
The [firewall](<../Security/Configuring Firewall.md>) must be configured to allowlist the client's IP address or netblock before connections can occur.

See the "Connecting using Mongosh" section of the Connect page for an example `mongosh` command-line, authentication instructions, and instructions to change the default password.
Loading

0 comments on commit c0e1fe9

Please sign in to comment.