You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: DEVELOPER_GUIDE.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -48,9 +48,9 @@ The `curl localhost:9200` call should succeed again. Kill the server with `Ctrl+
48
48
49
49
>Worth noting:\
50
50
> The version of OpenSearch and the security plugin must match as there is an explicit version check at startup. This can be a bit confusing as, for example, at the time of writing this guide, the `main` branch of this security plugin builds version `3.0.0.0-SNAPSHOT` compatible with OpenSearch `3.0.0`. Check the expected compatible version in `build.gradle` file [here](https://github.com/opensearch-project/security/blob/main/build.gradle) and make sure you get the correct branch from OpenSearch when building that project.
51
-
>
51
+
>
52
52
> The line to look for: `opensearch_version = System.getProperty("opensearch.version", "x")`
53
-
>
53
+
>
54
54
> Alternatively, you can find the compatible version of OpenSearch by running in project root folder
Copy file name to clipboardExpand all lines: DEVELOPING_WITH_DOCKER.md
+17-17
Original file line number
Diff line number
Diff line change
@@ -1,40 +1,40 @@
1
1
# Developing with Docker
2
2
3
-
Docker is a powerful tool that can be used to quickly spin up an OpenSearch cluster. When you follow the steps to run [OpenSearch with Docker](https://opensearch.org/docs/latest/install-and-configure/install-opensearch/docker/), you will find the Security Plugin already included in the basic distribution.
3
+
Docker is a powerful tool that can be used to quickly spin up an OpenSearch cluster. When you follow the steps to run [OpenSearch with Docker](https://opensearch.org/docs/latest/install-and-configure/install-opensearch/docker/), you will find the Security Plugin already included in the basic distribution.
4
4
5
5
-[Developing with Docker](#developing-with-docker)
6
6
-[Configuring Security](#configuring-security)
7
7
-[Mounting Local Volumes](#mounting-local-volumes)
By default, the Docker installation of OpenSearch does not enable the Security plugin. In order to enable Security development, you will need set `DISABLE_SECURITY_PLUGIN=false`, as well as change `DISABLE_INSTALL_DEMO_CONFIG` and `DISABLE_SECURITY_DASHBOARDS_PLUGIN`. This will install the demo certificates, and allow you to develop with realistic Security configurations. An example of a completely configured docker-compose file is shown below.
11
+
## Configuring Security
12
+
13
+
By default, the Docker installation of OpenSearch does not enable the Security plugin. In order to enable Security development, you will need set `DISABLE_SECURITY_PLUGIN=false`, as well as change `DISABLE_INSTALL_DEMO_CONFIG` and `DISABLE_SECURITY_DASHBOARDS_PLUGIN`. This will install the demo certificates, and allow you to develop with realistic Security configurations. An example of a completely configured docker-compose file is shown below.
14
14
15
15
> Warning: You should never use the demo certificates for a production environment. Instead, you will need to follow the steps on [configuring security](https://opensearch.org/docs/latest/security/configuration/index/) before using the cluster for production.
16
16
17
-
### Mounting Local Volumes
17
+
### Mounting Local Volumes
18
18
19
-
In order to test development changes with an OpenSearch Docker-installation, you will need to mount the volumes in your docker-compose file.
19
+
In order to test development changes with an OpenSearch Docker-installation, you will need to mount the volumes in your docker-compose file.
20
20
21
-
To update your cluster to have local changes, follow these steps:
21
+
To update your cluster to have local changes, follow these steps:
22
22
23
23
1. First you will need to make changes in your local `opensearch-project/security` repository. For this example, assume your fork is cloned into a directory called `security`.
24
-
2. After you make changes to your cloned repository, you will need to run `./gradlew assemble`. This will create a `.jar` file you can mount into the Docker container. The file will be located at `./security/build/distributions/opensearch-security-<OPENSEARCH_VERSION>.0-SNAPSHOT.jar`, where the `<OPENSEARCH_VERSION>` field is simply the OpenSearch distribution.
25
-
3. You will then need to navigate to your `docker-compose.yml` file where you are running you OpenSearch cluster from. For this example, let us assume this is in another directory called `opensearch-docker`.
26
-
4. Modify the compose file, so that in the `volumes:` section of each node configuration (the default configuration will have `opensearch-node1` and `opensearch-node2`), you have a new line which reads `~/security/build/distributions/opensearch-security-<OPENSEARCH_VERSION>.0-SNAPSHOT.jar:/usr/share/opensearch/plugins/opensearch-security/opensearch-security-<OPENSEARCH_VERSION>.0.jar`. This line should be added to the volumes section of all nodes in the compose file. You will not need to add it to the `opensearch-dashboards` section.
27
-
5. You can now restart the Docker container by running `docker-compose down -v` and `docker-compose up`. Your changes will now be live in the OpenSearch cluster instance.
24
+
2. After you make changes to your cloned repository, you will need to run `./gradlew assemble`. This will create a `.jar` file you can mount into the Docker container. The file will be located at `./security/build/distributions/opensearch-security-<OPENSEARCH_VERSION>.0-SNAPSHOT.jar`, where the `<OPENSEARCH_VERSION>` field is simply the OpenSearch distribution.
25
+
3. You will then need to navigate to your `docker-compose.yml` file where you are running you OpenSearch cluster from. For this example, let us assume this is in another directory called `opensearch-docker`.
26
+
4. Modify the compose file, so that in the `volumes:` section of each node configuration (the default configuration will have `opensearch-node1` and `opensearch-node2`), you have a new line which reads `~/security/build/distributions/opensearch-security-<OPENSEARCH_VERSION>.0-SNAPSHOT.jar:/usr/share/opensearch/plugins/opensearch-security/opensearch-security-<OPENSEARCH_VERSION>.0.jar`. This line should be added to the volumes section of all nodes in the compose file. You will not need to add it to the `opensearch-dashboards` section.
27
+
5. You can now restart the Docker container by running `docker-compose down -v` and `docker-compose up`. Your changes will now be live in the OpenSearch cluster instance.
28
28
29
-
### Example docker-compose
29
+
### Example docker-compose
30
30
31
-
This is an example of a completely configured docker-compose file for a local installation of the 2.5.0 version of OpenSearch.
31
+
This is an example of a completely configured docker-compose file for a local installation of the 2.5.0 version of OpenSearch.
32
32
33
33
```
34
34
version: '3'
35
35
services:
36
36
opensearch-node1:
37
-
image: opensearchstaging/opensearch:2.5.0 # This is a image of the 2.5.0 distribution
37
+
image: opensearchstaging/opensearch:2.5.0 # This is a image of the 2.5.0 distribution
38
38
environment:
39
39
- cluster.name=opensearch-cluster
40
40
- node.name=opensearch-node1
@@ -58,7 +58,7 @@ services:
58
58
# - ./config/opensearch.yml:/usr/share/opensearch/config/opensearch.yml # These paths are relative to the location of the docker-compose file
Copy file name to clipboardExpand all lines: TRIAGING.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ If you have an issue you'd like to bring forth please consider getting a link to
20
20
21
21
### Is there an agenda for each week?
22
22
23
-
Meetings are lightly structured as follows:
23
+
Meetings are lightly structured as follows:
24
24
25
25
1. Announcements: If there are any announcements to be made they will happen at the start of the meeting.
26
26
2. Review of new issues: The meetings always start with reviewing all untriaged [issues](https://github.com/search?q=label%3Auntriaged+is%3Aopen++repo%3Aopensearch-project%2Fsecurity+repo%3Aopensearch-project%2Fsecurity-dashboards-plugin&type=issues&ref=advsearch&s=created&o=desc) for the security and security-dashboards repositories.
@@ -53,7 +53,7 @@ There you can find answers to many common questions as well as speak with implem
53
53
54
54
### What if my issue is critical to OpenSearch operations, do I have to wait for the weekly meeting for it to be addressed?
55
55
56
-
All new issues for the [security](https://github.com/opensearch-project/security/issues?q=is%3Aissue+is%3Aopen+label%3Auntriaged) repo and [security-dashboards](https://github.com/opensearch-project/security-dashboards-plugin/issues?q=is%3Aissue+is%3Aopen+-label%3Atriaged) repo are reviewed daily to check for critical issues which require immediate triaging. If an issue relates to a severe concern for OpenSearch operation, it will be triaged by a maintainer mid-week. You can still come to discuss an issue at the following meeting even if it has already been triaged during the week.
56
+
All new issues for the [security](https://github.com/opensearch-project/security/issues?q=is%3Aissue+is%3Aopen+label%3Auntriaged) repo and [security-dashboards](https://github.com/opensearch-project/security-dashboards-plugin/issues?q=is%3Aissue+is%3Aopen+-label%3Atriaged) repo are reviewed daily to check for critical issues which require immediate triaging. If an issue relates to a severe concern for OpenSearch operation, it will be triaged by a maintainer mid-week. You can still come to discuss an issue at the following meeting even if it has already been triaged during the week.
57
57
58
58
### Is this where I should bring up potential security vulnerabilities?
0 commit comments