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

add enterprise tag for en doc #2148

Merged
merged 1 commit into from
Jul 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Installing NebulaGraph from the source code allows you to customize the compilin
- The host to be installed with NebulaGraph has access to the Internet.

{{ ent.ent_begin }}
- The [license key](../../9.about-license/2.license-management-suite/3.license-manager.md) is loaded.
- For NebulaGraph Enterprise, you must have the [license key](../../9.about-license/1.license-overview.md#licensing-process) loaded in [LM](../../9.about-license/2.license-management-suite/3.license-manager.md).
{{ ent.ent_end }}

## Installation steps
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ Using Docker Compose can quickly deploy NebulaGraph services based on the prepar
* You have started the Docker service on your host.

* If you have already deployed another version of NebulaGraph with Docker Compose on your host, to avoid compatibility issues, you need to delete the `nebula-docker-compose/data` directory.

{{ ent.ent_begin }}
* For NebulaGraph Enterprise, you must have the [license key](../../9.about-license/1.license-overview.md#licensing-process) loaded in [LM](../../9.about-license/2.license-management-suite/3.license-manager.md).
{{ ent.ent_end }}

## Deploy NebulaGraph

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You can install NebulaGraph by downloading the tar.gz file.
{{ ent.ent_begin }}
## Prerequisites

- The [license key](../../9.about-license/2.license-management-suite/3.license-manager.md) is loaded.
For NebulaGraph Enterprise, you must have the [license key](../../9.about-license/1.license-overview.md#licensing-process) loaded in [LM](../../9.about-license/2.license-management-suite/3.license-manager.md).
{{ ent.ent_end }}

## Installation steps
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ For now, NebulaGraph does not provide an official deployment tool. Users can dep
- Prepare 5 machines for deploying the cluster.
- Use the NTP service to synchronize time in the cluster.
{{ ent.ent_begin }}
- The [license key](../../9.about-license/2.license-management-suite/3.license-manager.md) is loaded.
- * For NebulaGraph Enterprise, you must have the [license key](../../9.about-license/1.license-overview.md#licensing-process) loaded in [LM](../../9.about-license/2.license-management-suite/3.license-manager.md).
{{ ent.ent_end }}

## Manual deployment process
Expand Down Expand Up @@ -59,7 +59,7 @@ Users can refer to the content of the following configurations, which only show
{{ ent.ent_begin }}
!!! enterpriseonly

For Enterprise Edition, set the value of `license_manager_url` to the host IP and port number `9119` where the license management tool is located in the Meta service configuration file of NebulaGraph (`nebula-metad.conf`), e.g. `192.168.8.100:9119`.
For Enterprise Edition, set the value of `license_manager_url` to the host IP and port number `9119` where the license management tool is located in the Meta service configuration files of NebulaGraph (`nebula-metad.conf`), e.g. `192.168.8.100:9119`.
{{ ent.ent_end }}

- Deploy machine A
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ For all parameters and their current values, see [Configurations](1.configuratio
* `timezone_name` is only used to transform the data stored in NebulaGraph. Other time-related data of the NebulaGraph processes still uses the default time zone of the host, such as the log printing time.

{{ ent.ent_begin }}

## enterprise license configurations

| Name | Predefined value | Description |Whether supports runtime dynamic modifications|
Expand Down
2 changes: 1 addition & 1 deletion docs-2.0/9.about-license/1.license-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ You can view the license information, including the expiration date, nodes purch

## License key

A license key is an encrypted string containing authorization information and serves as the unique credential for you to obtain access to the NebulaGraph Enterprise and its associated software features. There are two forms of License keys: online license keys and offline license keys. For more information, see [License key](2.license-management-suite/2.license-center.md#license-key).
A license key is an encrypted string containing authorization information and serves as the unique credential for you to obtain access to the NebulaGraph Enterprise and its associated software features. There are two forms of license keys: online license keys and offline license keys. For more information, see [License key](2.license-management-suite/2.license-center.md#license-key).

## Licensing process flowchart

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ License Center (LC) provided by Vesoft is an online platform for managing licens

To generate a license key, you need to bind the [ID of your License Manager (LM)](#bind-lmid) on LC. The license key must then be loaded into the installed LM service. And after specifying the LM access address in the software, you can authorize the license which enables you to use NebulaGraph Enterprise.

This article introduces how to set up an LC account, bind the LMID, and generate and load the license key.
This article introduces how to set up an LC account, bind the LMID, and generate the license key.

## Preparations

Expand Down Expand Up @@ -43,7 +43,7 @@ To use LC, you must first set up an LC account.

## Bind LMID to generate a license key

After you log in to LC, you can bind the ID of your LM to generate a license key.
After you log in to LC, you need bind the ID of your LM to generate a license key.

!!! caution

Expand Down Expand Up @@ -86,13 +86,9 @@ The following describes how to quickly bind the LMID:
- If your LM is accessible from the internet, you can select either **Online** or **Offline** mode. The **Online** mode is recommended, as it generates an online license key.
- If your LM is not accessible from the internet, then **Offline** mode is the only option available for generating an offline license key, as it can't reach out to the license server to validate the key itself.

For information about how to bind the ID of your LM, see the following section **Bind LMID**.
### Bind LMID on the license information page

### Subscriptions

This section displays the subscription ID of the cloud marketplace where your license is purchased, your subscription platform account, product ID, and subscription details.

## Bind LMID
If you skip the quick binding, you can still bind the LMID on the license information page.

1. On the targeted license details page, click **Bind License Manager ID**.
2. In the pop-up panel, enter the ID of your LM. For how to view LMID, see [LM](3.license-manager.md).
Expand Down Expand Up @@ -135,7 +131,7 @@ After you bind the LMID, a license key is automatically generated and the **Lice

### Subscription

This section is only displayed when you purchase a license on a cloud marketplace. the subscription ID of the cloud marketplace where your license is purchased, your subscription platform account, product ID, and subscription details.
This section is only displayed when you purchase a license on a cloud marketplace. In this section, you can view the subscription ID of the cloud marketplace where your license is purchased, your subscription platform account, product ID, and subscription details.



Expand Down
15 changes: 13 additions & 2 deletions docs-2.0/reuse/source_install-nebula-graph-by-rpm-or-deb.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,20 @@ RPM and DEB are common package formats on Linux systems. This topic shows how to
The console is not complied or packaged with NebulaGraph server binaries. You can install [nebula-console](https://github.com/vesoft-inc/nebula-console) by yourself.

{{ ent.ent_begin }}

!!! enterpriseonly

For NebulaGraph Enterprise, please [contact us](https://www.nebula-graph.io/contact).

For the Enterprise Edition, please [contact us](https://www.nebula-graph.io/contact).
{{ ent.ent_end }}

## Prerequisites

- The tool `wget` is installed.
- The [license key](https://docs.nebula-graph.io/{{nebula.release}}/9.about-license/2.license-management-suite/3.license-manager/) is loaded.

{{ ent.ent_begin }}
- For NebulaGraph Enterprise, you must have the [license key](../9.about-license/1.license-overview.md#licensing-process) loaded in [LM](../9.about-license/2.license-management-suite/3.license-manager.md).
{{ ent.ent_end }}

## Download the package from cloud service

Expand Down Expand Up @@ -160,8 +166,13 @@ RPM and DEB are common package formats on Linux systems. This topic shows how to
The default installation path is `/usr/local/nebula/`.

{{ ent.ent_begin }}

## Configure the address of license management

!!! enterpriseonly

This step is required only for NebulaGraph Enterprise.

In the Meta service configuration file (`nebula-metad.conf`) of NebulaGraph, set the value of `license_manager_url` to the host IP and port number `9119` where the license management tool is located, e.g. `192.168.8.100:9119`.
{{ ent.ent_end }}

Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -265,8 +265,8 @@ extra:
azureLatestRelease: 3.1.0 # The latest doc version that supports Azure Cloud
aliyunLatestRelease: 3.1.0 # The latest doc version that supports Alibaba Cloud
ent:
ent_begin: <!--> # change to "<!-->" when releasing core-ent
ent_end: <!--> # change to "<!-->" when releasing core-ent
ent_begin: <!- -> # change to "<!- ->" when releasing core-ent
ent_end: <!- -> # change to "<!- ->" when releasing core-ent

nav:
- About: README.md
Expand Down