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.

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

5.5 GA Java Client [PA-512] #1357

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

sergey-serdyukov
Copy link

@sergey-serdyukov sergey-serdyukov commented Nov 1, 2024

Proposed hz-docs changes to Java Standalone client documentation for 5.5-GA PA-512

Copy link

netlify bot commented Nov 1, 2024

Deploy Preview for hardcore-allen-f5257d ready!

Name Link
🔨 Latest commit 164b2b0
🔍 Latest deploy log https://app.netlify.com/sites/hardcore-allen-f5257d/deploys/6788e833b8ef9600085bd6fe
😎 Deploy Preview https://deploy-preview-1357--hardcore-allen-f5257d.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@sergey-serdyukov sergey-serdyukov changed the title 5.5 GA Java Client 5.5 GA Java Client [PA-512] Nov 1, 2024
@oliverhowell oliverhowell self-assigned this Nov 21, 2024
@alexey-agapov-hazelcast alexey-agapov-hazelcast requested a review from a team as a code owner December 2, 2024 14:59
Copy link
Contributor

@ihsandemir ihsandemir left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The deploy preview shows the 6.0 snapshot, is there something wrong here? I also expect the version 5.5.0 instead of 5.5.0-BETA, can you fix this?

@Rob-Hazelcast
Copy link
Contributor

The deploy preview shows the 6.0 snapshot, is there something wrong here?

@ihsandemir This is a branch off Main, which corresponds to the next major release (6.0). If this needs to appear in earlier versions too, @sergey-serdyukov can apply a label to this PR which prompts GitHub to create duplicate pull requests on release branches (5.5 and earlier, or just 5.5). If this needs to only appear in 5.5 and not future versions, he can change the base branch.

@ihsandemir ihsandemir added the backport to 5.5 Backport commits from main to v/5.5 label Dec 30, 2024
@ihsandemir
Copy link
Contributor

The deploy preview shows the 6.0 snapshot, is there something wrong here?

@ihsandemir This is a branch off Main, which corresponds to the next major release (6.0). If this needs to appear in earlier versions too, @sergey-serdyukov can apply a label to this PR which prompts GitHub to create duplicate pull requests on release branches (5.5 and earlier, or just 5.5). If this needs to only appear in 5.5 and not future versions, he can change the base branch.

@Rob-Hazelcast I added the label but did not see the backport PR generated, can you check if something is missing?

@Rob-Hazelcast
Copy link
Contributor

Rob-Hazelcast commented Dec 30, 2024

@Rob-Hazelcast I added the label but did not see the backport PR generated, can you check if something is missing?

Sorry for being unclear in my previous comment. The 5.5 PR will be generated when this PR is merged.

@oliverhowell
Copy link
Contributor

I also expect the version 5.5.0 instead of 5.5.0-BETA, can you fix this?

If this relates to the download links this will need a separate update to https://github.com/hazelcast/hz-docs/blob/main/docs/antora.yml to update the related standalone variables (I will raise this separately as file not in this PR).

@@ -1,4 +1,4 @@
= Java Client
client= Java Client
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does this line do?

docs/modules/clients/pages/java.adoc Outdated Show resolved Hide resolved
docs/modules/clients/pages/java.adoc Outdated Show resolved Hide resolved
docs/modules/clients/pages/java.adoc Outdated Show resolved Hide resolved
docs/modules/clients/pages/java.adoc Outdated Show resolved Hide resolved
docs/modules/clients/pages/java.adoc Outdated Show resolved Hide resolved
@oliverhowell
Copy link
Contributor

More questions:

  1. What is the official version of the client? 5.5.0 or 5.5.2?
  2. If we are releasing v8 and v17 as separate JARs, where is the equivalent update for the get started links and explanation on v8 vs v17?

@ihsandemir
Copy link
Contributor

More questions:

  1. What is the official version of the client? 5.5.0 or 5.5.2?
    5.5.0
  1. If we are releasing v8 and v17 as separate JARs, where is the equivalent update for the get started links and explanation on v8 vs v17?

Separate jars and separate zips. v8 is not finished yet.

@oliverhowell
Copy link
Contributor

  1. What is the official version of the client? 5.5.0 or 5.5.2?
    5.5.0

Thanks @ihsandemir - the related https://github.com/hazelcast/hz-docs/pull/1457/files PR has the correct version update then

@oliverhowell
Copy link
Contributor

Hello @sergey-serdyukov did you have a chance to review my comments and suggestions yet?


* Hazelcast Cloud is not supported
* XA transactions are not supported
* Only built-in sources and sinks are supported by the Pipeline API. External connectors, such as those for cloud storage (e.g., S3, Azure, GCS), databases (e.g., MongoDB, PostgreSQL, MySQL), streaming platforms (e.g., Kafka, Kinesis), and file formats (e.g., Avro, CSV), are not supported
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Only built-in sources and sinks are supported by the Pipeline API. External connectors, such as those for cloud storage (e.g., S3, Azure, GCS), databases (e.g., MongoDB, PostgreSQL, MySQL), streaming platforms (e.g., Kafka, Kinesis), and file formats (e.g., Avro, CSV), are not supported
* Only built-in sources and sinks are supported by the Pipeline API. External connectors, such as those used for cloud storage (e.g. S3, Azure, GCP), databases (e.g. MongoDB, PostgreSQL, MySQL), streaming platforms (e.g. Kafka, Kinesis), and file formats (e.g. Avro, CSV), are not supported

GCP rather than GCS?

* Hazelcast Cloud is not supported
* XA transactions are not supported
* Only built-in sources and sinks are supported by the Pipeline API. External connectors, such as those for cloud storage (e.g., S3, Azure, GCS), databases (e.g., MongoDB, PostgreSQL, MySQL), streaming platforms (e.g., Kafka, Kinesis), and file formats (e.g., Avro, CSV), are not supported
* Cloud support includes Hazelcast Cloud, Kubernetes, AWS, Azure, and Google Cloud Platform. Other environments, such as Apache jclouds, Consul, Docker, etcd, Eureka, Heroku, VMware Tanzu (formerly Pivotal Cloud Foundry), and Zookeeper, are not supported
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Cloud support includes Hazelcast Cloud, Kubernetes, AWS, Azure, and Google Cloud Platform. Other environments, such as Apache jclouds, Consul, Docker, etcd, Eureka, Heroku, VMware Tanzu (formerly Pivotal Cloud Foundry), and Zookeeper, are not supported
* Cloud support includes Hazelcast Cloud, Kubernetes, AWS, Azure, and GCP. Other environments, such as Apache jclouds, Consul, Docker, etcd, Eureka, Heroku, VMware Tanzu (formerly Pivotal Cloud Foundry), and Zookeeper, are not supported

@@ -72,7 +73,7 @@ You can find {java-client} code samples in the https://github.com/hazelcast/haze

TIP: For a tutorial on getting started with Java in an embedded topology, see xref:getting-started:get-started-java.adoc[].

=== Get started with {java-client-new} (BETA)
=== Get started with {java-client-new}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ihsandemir is this section still correct in terms of dependencies considering v8? Will this section have to expand to cover v8 vs v17?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for now we did not change the name of the dependency. we can assume it will be the same and if we change in the future, we can update it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Ihsan - I take it we do need to add information on which version of JDK is supported for the standalone client?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport to 5.5 Backport commits from main to v/5.5
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants