hazelcast/cloud-docs

Source content for the Hazelcast Cloud documentation

Hazelcast Cloud Documentation

This repository contains the Antora components for the Hazelcast Cloud documentation.

The documentation source files are marked up with AsciiDoc.

Docs Structure

This section describes some important information about how this repository is structured:

• The component name, version, and start page are configured in each branch’s antora.yml file.

• The navigation for all modules is stored in the ROOT module’s nav.adoc file.

• The docs site playbook instructs Antora to build the site using content in the main branch.

GitHub Actions

To automate some elements of the build process, this repository includes the following GitHub Actions:

Table 1. GitHub Actions

File	Description	Triggers
validate-site.yml	Validates that all internal and external links are working	On a pull request to the main branch
build-site.yml	Builds the production documentation site by sending a build hook to Netlify (the hosting platform that we use)	On a push to the main branch

Contributing

If you want to add a change or contribute new content, simply submit a pull request to the main branch. The documentation site is set up to build on a push. For more detailed information about the site structure, see our contributing guide.

To let us know about something that you’d like us to change, consider creating an issue.

License

All documentation is available under the terms of a Creative Commons License.

cloud-docs's Issues

SQL(CLI) Error Populating Map

Feedback is about the following page: https://docs.hazelcast.com/cloud/get-started

INSERT statement is throwing an error. Maybe due to separators.

INSERT INTO cities VALUES
(1, 'United Kingdom','London', 9_540_576),
(2, 'United Kingdom','Manchester', 2_770_434),
(3, 'United States', 'New York', 19_223_191),
(4, 'United States', 'Los Angeles', 3_985_520),
(5, 'Turkey', 'Ankara', 5_309_690),
(6, 'Turkey', 'Istanbul', 15_636_243),
(7, 'Brazil', 'Sao Paulo', 22_429_800),
(8, 'Brazil', 'Rio de Janeiro', 13_634_274);

Docs: Feedback for Java Client

Hi, I have some feedback about this page

config.setGroupConfig is no longer valid. You just use config.setClusterName and the token.

Docs: Feedback for What is Hazelcast Cloud?

Hi, I have some feedback about this page

The link in the Scalability and Flexibility section does not exist.

Docs: Feedback for Management Center

Hi, I have some feedback about this page

https://docs.hazelcast.com/cloud/management-center#before-you-begin Enterprise Plan link return 404.

Also I don't know how to connect with MC to the cloud since there is no plan.

Docs: Feedback for AWS VPC Peering

Hi, I have some feedback about this page

https://docs.hazelcast.com/cloud/aws-vpc-peering.html#listing-peerings

You can list Google Cloud Platform peerings on your Enterprise Hazelcast Cluster on GCP from Console by going Cluster Details > Settings > VPC Peering one by one as shown below. You can check where the connection established by checking VPC ID and Subnet from the list.

The text marked in bold should be AWS instead of GCP, please verify and correct it required

Docs: Feedback for API Reference

I guess the field isEnabledForStandard under cloudProviders query should be isEnabledForStarter

Serverless Cluster Creation documentation outdated

The Create Serverless Cluster documentation does not reflect the user workflow:

Click Create New Cluster.

Click Create Development Cluster.

Update the cluster name if you want to. You cannot change the cluster name after the cluster is created.

Click Create Cluster.

Get Started instruction ordering issue

There is no Step 6 in this section of the Get Started documentation:

Review how we document fixes in release notes

It would be nice to write fixes in terms of what happens now rather than what used to happen. For example:

Instead of '- Fixed an issue where the cluster details were still accessible for the deleted clusters'

We would say '- If a cluster is deleted, its details are no longer displayed under Cluster Details

This would avoid us repeating 'Fixed an issue where', which is redundant.

Client is not able to connect cluster with cluster-name returned from API

API returns that json
{ "data": { "cluster": { "id": "2865", "name": "alisengul-test" } } }
But in order to connect cluster we need to use name pr-2865

Docs: Feedback for Map

Hi, I have some feedback about this page

The section about asynchronous backup count is missing. The cloud GraphQL API references that section (#asynchronous-backup-count).

Docs: Feedback for Creating a Viridian Cloud Dedicated Cluster

Hi, I have some feedback about this page

To request a cluster on Viridian Cloud Dedicated, do the following:

Sign into the Viridian Cloud console.

Go to Plans > Dedicated in the left navigation.

Complete the form and click Get in touch.

The flow above is not working anymore. In the viridian.hazelcast.com website, there's a redirect to sign-in page and there's no left navigation there.

Docs: Feedback for Logging

Hi, I have some feedback about this page

Update to include CLC access to logs

Docs: Feedback for MapLoader and MapStore

Hi, I have some feedback about this page

The link at the top talks about Cloud plans but the link just takes the viewer to the cloud login page (which does not show any plan info)

Docs: Fix typos

Following on from hazelcast/hz-docs#811 for this repo.

Docs: Feedback for MapLoader and MapStore

Hi, I have some feedback about this page

The link at the top talks about Cloud plans but the link just takes the viewer to the cloud login page (which does not show any plan info)

Remove the version number from docs

cc @cangencer
Cloud does not support older releases. The version of cloud never changes for the user because it is just upgraded in the background.

As a result, version numbers are redundant in the URL and in product dropdowns.

Docs: Feedback for Getting Started with Hazelcast Cloud

Hi, I have some feedback about this page

I have downloaded hazelcast-5.0.zip in windows,after unzip,execute bin/hz-start.bat,it is always showing starting hazelcast in console,what else should I do before start?

Docs: Feedback for Query Streams from Confluent Cloud

Hi, I have some feedback about this page

This Streaming Real-Time Data tutorial on Viridian cannot be completed because it requires Hazelcast Enterprise Edition in order to run hz-cli.

ERROR: SSL/TLS requires Hazelcast Enterprise Edition