Skip to content

Doc 433 copyedit MC docs, part 1 #491

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

Open
wants to merge 28 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
cbb2276
doc-433-copyedit: overview (WIP)
amandalindsay Apr 2, 2025
b9c88f3
doc-433-copyedit: WIP
amandalindsay Apr 3, 2025
a023aa8
doc-433-copyedit: WIP
amandalindsay Apr 3, 2025
3b33d4d
doc-433-copyedit: updated ngrok version
amandalindsay Apr 7, 2025
1bb0328
doc-433-copyedit: update docs tools, replaced nav
amandalindsay Apr 7, 2025
498b5f7
doc-433-copyedit: install topic
amandalindsay Apr 7, 2025
dacf9cc
doc-433-copyedit: UI topics
amandalindsay Apr 7, 2025
cb3554c
doc-433-copyedit: scrub of Get started section
amandalindsay Apr 8, 2025
f2594df
Merge branch 'main' into doc-433-copyedit
amandalindsay Apr 8, 2025
72e437f
doc-433-copyedit: fix link text
amandalindsay Apr 8, 2025
f17883a
Merge branch 'doc-433-copyedit' of https://github.com/hazelcast/manag…
amandalindsay Apr 8, 2025
d5128ce
doc-433-copyedit: WIP
amandalindsay Apr 8, 2025
bbdae2a
doc-433-copyedit: deploy&manage topics
amandalindsay Apr 9, 2025
32afde7
Merge branch 'main' into doc-433-copyedit
amandalindsay Apr 10, 2025
3537ebf
doc-433-copyedit: security topics
amandalindsay Apr 10, 2025
a5f9f2d
Merge branch 'doc-433-copyedit' of https://github.com/hazelcast/manag…
amandalindsay Apr 10, 2025
36cb238
doc-433-copyedit: minor tweaks
amandalindsay Apr 10, 2025
d39e9a3
doc-433-copyedit: tweak nav
amandalindsay Apr 10, 2025
621d682
doc-433-copyedit: fixes from feedback on PR
amandalindsay Apr 22, 2025
bb1c264
Merge branch 'main' into doc-433-copyedit
amandalindsay Apr 22, 2025
1c18940
DOC-433-COPYEDIT: added prefix to fix doc bug DOC-450
amandalindsay May 6, 2025
8a00df5
doc-433-copyedit: tweak overview with enterprise features
amandalindsay May 15, 2025
b4e8e08
doc-433-copyedit: use variables for editions
amandalindsay May 15, 2025
0045d8f
doc-433-copyedit: added JG's comments
amandalindsay May 15, 2025
45a2e76
doc-433-copyedit: added features table
amandalindsay May 19, 2025
8bf038a
doc-433-copyedit: tidy features table
amandalindsay May 20, 2025
09deee0
DOC-433-copyedit: moved release notes
amandalindsay May 21, 2025
c41a7f7
DOC-433-COPYEDIT: promote release notes
amandalindsay May 21, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,7 @@ asciidoc:
page-latest-supported-clc: '5.4.1'
page-toclevels: 1
experimental: true
open-source-product-name: 'Community Edition'
enterprise-product-name: 'Enterprise Edition'
nav:
- modules/ROOT/nav.adoc
150 changes: 132 additions & 18 deletions docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,33 +1,147 @@
.Get Started
include::getting-started:partial$nav.adoc[]
.Get started
// include::getting-started:partial$nav.adoc[]
* xref:getting-started:overview.adoc[Overview]
// ** xref:ROOT:whats-new.adoc[What's new in 5.7]
* xref:ask-ai.adoc[]
* xref:getting-started:get-started.adoc[Docker Compose tutorial]
* User Interface overview
** xref:getting-started:user-interface.adoc[Top Bar and Side Bar]
** xref:getting-started:graphs.adoc[]
** xref:getting-started:tables.adoc[]
* xref:getting-started:get-support.adoc[Get support]

.Deploy and Manage
include::deploy-manage:partial$nav.adoc[]
.Install and upgrade
* xref:getting-started:install.adoc[Install and start]
//* Release notes
* xref:release-notes:releases.adoc[Release notes]
** xref:release-notes:5-7-0.adoc[5.7.0]
* xref:migration-guides.adoc[]


.Deploy and manage
// include::deploy-manage:partial$nav.adoc[]
* xref:deploy-manage:production-checklist.adoc[Production checklist]
* Configuration
** xref:deploy-manage:configuring.adoc[Overview]
** xref:deploy-manage:system-properties.adoc[]
** xref:deploy-manage:mc-conf.adoc[]
** xref:deploy-manage:variable-replacers.adoc[]
** xref:deploy-manage:logging.adoc[]
* Cluster connections
** xref:deploy-manage:cluster-connections.adoc[Overview]
** xref:deploy-manage:connecting-to-clusters-mc-conf.adoc[]
** xref:deploy-manage:connecting-to-clusters-ui.adoc[]
* License management
** xref:deploy-manage:license-management.adoc[Overview]
** xref:deploy-manage:updating-mc-license-ui.adoc[]
* Security
** xref:deploy-manage:security.adoc[Overview]
** TLS
*** xref:deploy-manage:tls-security.adoc[]
*** xref:deploy-manage:serving-https.adoc[]
*** xref:deploy-manage:serve-mc-over-https.adoc[Tutorial]
** User authentication
*** xref:deploy-manage:security-providers.adoc[]
*** xref:deploy-manage:dev-mode.adoc[]
*** xref:deploy-manage:local-security-provider.adoc[]
*** xref:deploy-manage:active-directory.adoc[]
*** xref:deploy-manage:ldap.adoc[]
*** xref:deploy-manage:jaas.adoc[]
*** xref:deploy-manage:saml.adoc[]
*** xref:deploy-manage:openid.adoc[]
*** xref:deploy-manage:switching-security-provider.adoc[]
** xref:deploy-manage:sessions.adoc[]
* xref:deploy-manage:user-management.adoc[User management]
* xref:deploy-manage:historical-metrics.adoc[Historical metrics]
* xref:deploy-manage:phone-homes.adoc[Phone homes]

.Integrate
include::integrate:partial$nav.adoc[]
// include::integrate:partial$nav.adoc[]
* xref:integrate:integrations.adoc[]
* xref:integrate:prometheus-monitoring.adoc[]
** xref:integrate:prometheus-metrics.adoc[]
* Clustered JMX
** xref:integrate:jmx.adoc[Get started with JMX]
** xref:integrate:jmx-api.adoc[]
* Clustered REST
** xref:integrate:clustered-rest.adoc[Get started with REST API]
** xref:integrate:client-filtering.adoc[]
** xref:integrate:cluster-metrics.adoc[]
** xref:integrate:cluster-connections.adoc[]
** xref:integrate:wan-replication.adoc[]

.Tools
include::tools:partial$nav.adoc[]
// include::tools:partial$nav.adoc[]
* xref:tools:overview.adoc[]
* xref:tools:sql-browser.adoc[]
* xref:tools:console.adoc[]
* xref:tools:scripting.adoc[]

.Cluster
include::clusters:partial$nav.adoc[]
// include::clusters:partial$nav.adoc[]
* xref:clusters:dashboard.adoc[Dashboard]
* xref:clusters:clients.adoc[Clients]
* xref:clusters:client-filtering.adoc[Client filtering]
** xref:clusters:create-filter-lists-ui.adoc[]
** xref:clusters:create-filter-lists-rest.adoc[]
* xref:clusters:members.adoc[Members]
* Administration
** xref:clusters:administration.adoc[Overview]
** Cluster states
*** xref:clusters:cluster-state.adoc[Overview]
*** xref:clusters:changing-cluster-state.adoc[]
*** xref:clusters:shutting-down-cluster.adoc[]
** xref:clusters:cluster-license.adoc[]
** xref:clusters:triggering-rolling-upgrade.adoc[Rolling upgrade]
** xref:clusters:update-config.adoc[Update Config]
** Persistence
*** xref:clusters:persistence.adoc[Overview]
*** xref:clusters:triggering-force-start.adoc[]
*** xref:clusters:triggering-partial-start.adoc[]
*** xref:clusters:triggering-hot-backup.adoc[]
* xref:clusters:wan-replication.adoc[WAN replication]
* xref:clusters:healthcheck.adoc[Healthcheck]
* xref:clusters:namespaces.adoc[Namespaces]

.Storage, Compute & Messaging
include::data-structures:partial$nav.adoc[]
.Storage, compute & messaging
// include::data-structures:partial$nav.adoc[]
* xref:data-structures:overview.adoc[]
* xref:data-structures:vector-collection.adoc[]
* xref:data-structures:map.adoc[]
* xref:data-structures:replicated-map.adoc[]
* xref:data-structures:cache.adoc[]
* xref:data-structures:multimap.adoc[]
* xref:data-structures:list.adoc[]
* xref:data-structures:set.adoc[]
* xref:data-structures:queue.adoc[]
* xref:data-structures:topic.adoc[]
* xref:data-structures:reliable-topic.adoc[]
* xref:data-structures:executor.adoc[]
* xref:data-structures:pn-counter.adoc[]
* xref:data-structures:flake-id-gen.adoc[]

.Streaming
include::monitor-streaming:partial$nav.adoc[]
// include::monitor-streaming:partial$nav.adoc[]
* xref:monitor-streaming:dashboard.adoc[]
* xref:monitor-streaming:jobs.adoc[]
* xref:monitor-streaming:snapshots.adoc[]
* xref:monitor-streaming:sql-tasks.adoc[]

.CP Subsystem
include::cp-subsystem:partial$nav.adoc[]
// include::cp-subsystem:partial$nav.adoc[]
* xref:cp-subsystem:dashboard.adoc[Dashboard]
* xref:cp-subsystem:cpmap.adoc[]
* xref:cp-subsystem:atomic-long.adoc[]
* xref:cp-subsystem:semaphore.adoc[]
* xref:cp-subsystem:atomic-ref.adoc[]
* xref:cp-subsystem:countdown-latch.adoc[]
* xref:cp-subsystem:fenced-lock.adoc[]

.Troubleshoot
include::troubleshoot:partial$nav.adoc[]

.Upgrade
** xref:migration-guides.adoc[]

.Release Notes
include::release-notes:partial$nav.adoc[]
// include::troubleshoot:partial$nav.adoc[]
* xref:troubleshoot:hazelcast-clusters.adoc[Hazelcast clusters]
* xref:troubleshoot:management-center.adoc[Management Center]

//.Release notes
// include::release-notes:partial$nav.adoc[]
// moved to Install & Upgrade
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/migration-guides.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Upgrading Management Center
= Upgrade Management Center
[[migration-guides]]

== Changes in 5.4.x
Expand Down
16 changes: 8 additions & 8 deletions docs/modules/deploy-manage/pages/active-directory.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

{description}

== Setting Up the Active Directory Security Provider
== Set up the Active Directory security provider

To set up Active Directory, you need to configure settings either in the UI or the `hz-mc conf` tool.

Expand All @@ -14,8 +14,8 @@ UI::
--
To set up the local security provider in the UI, go to *Settings* > *Security Providers* > *Active Directory*.

Before saving your configuration, you can test it by clicking the **Test**
button. The user you test with needs to be a member of one of
Before saving your configuration, test it by clicking **Test**.
The user you test with must be a member of one of
the groups you have configured for the Management Center.
--
mc-conf::
Expand Down Expand Up @@ -66,16 +66,16 @@ Center. To use more than one group, separate them with a semicolon (;).
* **Nested Group Search:** Disable if you have a large LDAP group structure
and it takes a long time to query all nested groups during login.

== Creating and Managing Users
== Create and manage users

To create and manage additional users, you must configure them in Active Directory.

When creating users, be sure to give them a valid role. See xref:user-management.adoc[].

== Updating Active Directory Settings
== Update Active Directory settings

Once configured, Active Directory settings are saved in a local database managed by Management Center.
If you need to update your settings afterwards, you need to provide the import properties file under `<hazelcast-mc>/import/securityHotReload.properties`, and then click on the **Reload Security Config** button on the login page.
If you need to update your settings afterwards, you need to provide the import properties file under `<hazelcast-mc>/import/securityHotReload.properties`, and then click **Reload Security Config** on the login page.
The `securityHotReload.properties` should contain the following properties:

```
Expand All @@ -97,11 +97,11 @@ but you need to stop the Management Center service for this configuration option
See xref:deploy-manage:mc-conf.adoc[] for more information.

[[ad-ssl]]
== Enabling TLS/SSL for Active Directory
== Enable TLS/SSL for Active Directory

If your Active Directory service is using TLS/SSL protocol, use the command line parameters for your Management Center
deployment xref:deploy-manage:system-properties.adoc#hazelcast-mc-ad-ssl-protocol[Active Directory SSL configuration options].

== Next Steps
== Next steps

For details about the `hz-mc conf` tool, see xref:mc-conf.adoc[].
14 changes: 7 additions & 7 deletions docs/modules/deploy-manage/pages/cluster-connections.adoc
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
= Cluster Connections
= Cluster connections
:description: You can connect Management Center to multiple clusters and remove connections when you no longer need them.
:page-aliases: ROOT:connecting-members.adoc

To connect Management Center to a Hazelcast cluster, you need to configure at least the name of the cluster and the addresses of one or more members.
To connect Management Center to a Hazelcast cluster, you need to configure at minimum the name of the cluster and the addresses of one or more members.

To configure these settings, you can use one of the following options:
To configure these settings, use one of the following options:

- xref:connecting-to-clusters-ui.adoc[Connect to a cluster from the web UI].
- Preconfigure Management Center to connect to a cluster on start:

** xref:connecting-to-clusters-mc-conf.adoc[`hz-mc conf` tool]
** <<environment-variables,Environment variables>>

== Connecting to Clusters with TLS Enabled
== Connect to clusters with TLS enabled

If a Hazelcast cluster is configured to use TLS, you need to configure the truststore on Management Center, using a client configuration file.

To configure Management Center with a client configuration file, use one of the following options:

- xref:connecting-to-clusters-ui.adoc#using-a-client-configuration-file[UI].
- xref:connecting-to-clusters-ui.adoc#using-a-client-configuration-file[UI]

- xref:connecting-to-clusters-mc-conf.adoc[`hz-mc conf` tool]

For more information about configuring a client configuration file for TLS, see xref:{page-latest-supported-hazelcast}@hazelcast:security:tls-ssl.adoc#tlsssl-for-hazelcast-clients[TLS for Hazelcast Clients] in the Platform documentation.

== Environment Variables
== Environment variables

If you use the terminal to start Management Center for example by executing the JAR file or a script, you can set the following environment variables:
If you use the terminal to start Management Center, for example by executing the JAR file or a script, you can set the following environment variables:

[cols="20%m,80%a"]
|===
Expand Down
10 changes: 5 additions & 5 deletions docs/modules/deploy-manage/pages/configuring.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
= Configuring Management Center
= Configure Management Center
:description: You can use various options to configure the Management Center instance as well as the client that Management Center uses to connect to and interact with Hazelcast clusters.

{description}

For example, you may want to configure the client to connect to certain Hazelcast members. You may also want to configure the home directory of the Management Center instance to customize where metrics and other configuration data is saved.

== Where Management Center Saves Data
== Where Management Center saves data

By default, Management Center saves the following data in the `hazelcast-mc` directory of the user's home directory:

Expand All @@ -14,7 +14,7 @@ By default, Management Center saves the following data in the `hazelcast-mc` dir

You can configure Management Center to save this data in a different location, using the xref:system-properties.adoc#hazelcast-mc-home[`hazelcast.mc.home` property].

== Ways to Configure Management Center
== Ways to configure Management Center

You can either configure Management Center in the UI while it's running or preconfigure it in the terminal so that it starts with the settings you need.

Expand Down Expand Up @@ -44,7 +44,7 @@ You can either configure Management Center in the UI while it's running or preco

|===

=== Configuring the Client
=== Configure the client

Because Management Center connects to Hazelcast clusters as a client, you can configure it, using the following methods:

Expand All @@ -62,6 +62,6 @@ never gives up trying to connect to the cluster.
- `network.smart-routing`: Set to `true` so that Management Center will open connections to all
members.

=== Member-Side Configuration
=== Member-side configuration

On a Hazelcast member, you can also use the `management-center` setting to enable or disable both scripting and the console as well as setting up trusted interfaces. See xref:{page-latest-supported-hazelcast}@hazelcast:maintain-cluster:monitoring.adoc#management-center[Management Center] in the Platform documentation.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Connecting to a Cluster with the hz-mc conf Tool
= Connect with hz-mc conf
:description: You can preconfigure the client connection to a cluster before you start Management Center, using the `hz-mc conf` tool.

Management Center starts a Hazelcast client for each cluster that it is connected to. You can preconfigure the client connection to a cluster before you start Management Center, using the `hz-mc conf` tool.
Expand All @@ -10,21 +10,21 @@ To connect Management Center to a Hazelcast cluster, using the `hz-mc conf` tool
+
NOTE: If you enabled TLS/SSL on a Hazelcast cluster, you must use this option to configure the client TLS settings. For more information about TLS configuration, see xref:{page-latest-supported-hazelcast}@hazelcast:security:tls-ssl.adoc[TLS] in the Platform documentation.

== Before you Begin
== Before you begin

Make sure that Management Center is not running. If you execute a CLI command while Management Center is running, you will see the following error: `Could not lock home directory`.

For a getting started guide, see xref:mc-conf.adoc[].

== Configuring a Cluster Connection
== Configure a cluster connection

. To provide the cluster name and member addresses, use the following:
+
```bash
hz-mc conf cluster add -cn={cluster name} -ma={member addresses}
```
+
You should see the following:
You should see:
+
```
Successfully added Cluster Config.
Expand All @@ -36,7 +36,7 @@ Successfully added Cluster Config.
hz-mc conf cluster add --client-config={path to file}
```
+
You should see the following:
You should see:
+
```
Successfully added Cluster Config.
Expand All @@ -47,25 +47,25 @@ For help creating a client configuration file, see the link:https://github.com/h

. Start Management Center.

To connect to another cluster, you can repeat these steps.
To connect to another cluster, repeat these steps.

NOTE: When connecting to multiple clusters from the same instance of Management Center, make sure that the cluster names are unique. Management Center does not support simultaneous connections to more than one cluster with the same cluster name.

== Removing a Cluster Connection
== Remove a cluster connection

To remove an existing connection to a cluster, use the following:

```bash
hz-mc conf cluster remove -cn={cluster name}
```

You should see the following:
You should see:

```
Successfully removed Cluster Config.
```

== Next Steps
== Next steps

For the full reference of `mc-cli`, see xref:mc-conf.adoc[]

Expand Down
Loading
Loading