Updates Dev guide #897

DarshitChanpura · 2022-02-01T23:01:50Z

Description

Enhances the dev-guide to be more elaborative and intuitive.

Check List

Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

codecov-commenter · 2022-02-01T23:11:24Z

Codecov Report

Merging #897 (f6c152b) into main (f0cb0c4) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #897   +/-   ##
=======================================
  Coverage   72.14%   72.14%           
=======================================
  Files          87       87           
  Lines        1906     1906           
  Branches      242      242           
=======================================
  Hits         1375     1375           
  Misses        477      477           
  Partials       54       54

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f0cb0c4...f6c152b. Read the comment docs.

davidlago · 2022-02-01T23:09:23Z

DEVELOPER_GUIDE.md


-As a prerequisite, please follow [the developer guide of the Security Plugin](https://github.com/opensearch-project/security/blob/main/DEVELOPER_GUIDE.md). This will leave you with a running OpenSearch server with security enabled. For the sake of this guide, let's assume the latest versions at the time of writing (`1.3.0-SNAPSHOT` for OpenSearch and OpenSearch Dashboards, and `1.3.0.0-SNAPSHOT` for both backend and frontend (this repo) security plugins.) Update the config file (`config/opensearch.yml`) to look like this one:
+This project is as a plugin of [OpenSearch-Dashboards](**https://github.com/opensearch-project/OpenSearch-Dashboards). It requires an [OpenSearch](https://github.com/opensearch-project/OpenSearch) server running with the [Security](https://github.com/opensearch-project/security) plugin installed. At the time of this writing there is a strict version check between these components, so we recommend running all of them from their respective branches with matching versions (this will also ensure they work well together before we cut a new release.)


Probably a typo (is as a plugin)

davidlago · 2022-02-01T23:11:45Z

DEVELOPER_GUIDE.md

@@ -39,7 +49,15 @@ node.max_local_storage_nodes: 3
 ######## End OpenSearch Security Demo Configuration ########
 ```

-Next, we need to check out OpenSearch Dashboards from the branch matching our version, in this example that would be the [1.x branch](https://github.com/opensearch-project/OpenSearch-Dashboards/tree/1.x). Follow the [developer guide](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/1.x/DEVELOPER_GUIDE.md) and replace the version of  `opensearch-dashboards.yml` there with this:
+
+**Please Note** : This project runs on node `10.24.1` and so when installing node please ensure that you install this version. You can do so by running 


I'd probably make this relative to .node-version so we don't have to upgrade every time (I'm not sure if we already use a .node-version file but we should)

ahaa...yes...we do use .node-version and .nvm-rc.. I just added an extra explanation saying "refer to .node-version file in base directory"

pc-jedi · 2022-02-03T10:41:30Z

DEVELOPER_GUIDE.md

+
+**Please Note** : This project runs on node `10.24.1` (refer to the `.nvmrc` or `.node-version` file in the base directory for correct version) and so when installing node please ensure that you install this version. You can do so by running 
+```script 
+nvm install 10.24.1


Suggested change

nvm install 10.24.1

nvm use --install

That way we don't have to specify the version explicitly, since it is picked up from .nvmrc

What's the deal with this comment?

Just an idea for an improvement on the docs. E.g. if we move towards 2.0 the node version changed and that would mean we always have to update the docs when we change .nvmrc. If we simply use the nvm use --install command we then don't have to upgrade the docs all the time.

hsiang9431-amzn · 2022-02-03T19:37:26Z

DEVELOPER_GUIDE.md

+
+**IMPORTANT**: Throughout this guide we will be using 1.x branches as our source for all 4 repos (OpenSearch, OpenSearch-Dashboards, security and security-dashboards-plugin).
+
+> NOTE: If you are following this guide by the dot, please make sure that source code that you compile for OpenSearch project using `./gradlew localDistro` is done from [1.x branch](https://github.com/opensearch-project/OpenSearch/tree/1.x)


Are we updating this statement every time the branch is changed?

L14 says this is used just during the guide as just an example. The paragraph above makes reference to the need for matching versions. But yeah, if we move to a major version (2, 3...) it might be a bit confusing so we can update. Perhaps we can omit L14 as L10 covers the general idea and then we move on to use 1.3.0 as a driving example (that part can stay as it is clear it's just for the sake of the example code)

I think down the road when there are multiple versions and branches for developers to choose, adding a table to show each version with there corresponding branch will be helpful

I have added the relevant branch and version info here... we can add info to this table as we develop in the future

DarshitChanpura · 2022-02-04T17:30:41Z

DEVELOPER_GUIDE.md

+\
+For the sake of this guide, let's assume that the latest versions (`1.3.0-SNAPSHOT` for OpenSearch and OpenSearch Dashboards, and `1.3.0.0-SNAPSHOT` for the backend and the frontend of this Security plugin).
+
+Next, ensure that the config file (`config/opensearch.yml`) in the OpenSearch home directory where you copied the source code using the [dev-guide](https://github.com/opensearch-project/security/blob/main/DEVELOPER_GUIDE.md#:~:text=export%20OPENSEARCH_HOME%3D~/Test/opensearch%2D1.3.0%2DSNAPSHOT) (basically `cd $OPENSEARCH_HOME`) contains this:


@hsiang9431-amzn @davidlago ... can you please review this again?

cliu123 · 2022-03-28T18:01:10Z

ITs failed. Would you please take a look?

cliu123 · 2022-03-28T18:57:03Z

Is there a template reference of the Dev Guide?
Please sign the commits. All commits are "Unverified".

DarshitChanpura · 2022-03-28T19:23:43Z

Is there a template reference of the Dev Guide? Please sign the commits. All commits are "Unverified".

I did sign all the commits idk why it says Unsigned...Shouldn't DCO check fail if commits are unsigned?

DarshitChanpura · 2022-03-28T19:31:44Z

ITs are failing because the integration test uses 1.x branch as base for OpenSearch-Dashboards (see here)

Because 1.x has been bumped to 1.4 in the core dashboards repo, there is a mismatch between plugin's expected version (1.4.0.0) and actual version (1.3.0.0) when integration tests are run. This results in failing ITs.

Error log from one of the failing tests:

start OpenSearch Dashboards server › call multitenancy info API as admin

    Failed to initialize plugins:
    	Plugin "securityDashboards" is only compatible with OpenSearch Dashboards version "1.3.0", but used OpenSearch Dashboards version is "1.4.0". (incompatible-version, /home/runner/work/security-dashboards-plugin/security-dashboards-plugin/OpenSearch-Dashboards/plugins/security-dashboards-plugin/opensearch_dashboards.json)

      214 |       .toPromise();
      215 |     if (errors.length > 0) {
    > 216 |       throw new Error(
          |             ^
      217 |         `Failed to initialize plugins:${errors.map((err) => `\n\t${err.message}`).join('')}`
      218 |       );
      219 |     }

      at PluginsService.handleDiscoveryErrors (src/core/server/plugins/plugins_service.ts:216:13)

This change will be updated to point to main in 2.0 version bump PR: #928

DarshitChanpura · 2022-03-28T19:32:30Z

I would suggest waiting until main branch is bumped to 2.0 and then rebasing this branch with main before merging it.

cliu123 · 2022-06-08T23:41:43Z

@DarshitChanpura main branch has been bumped to 2.1.0.0 now. Do you want to rebase and get it ready for review?

Signed-off-by: Darshit Chanpura <[email protected]>

DarshitChanpura · 2022-06-27T15:13:52Z

@opensearch-project/security Can I get review on this?

peternied · 2022-06-27T20:58:02Z

DEVELOPER_GUIDE.md

+
+| OpenSearch<br>branch | Security Plugin<br>branch  | OpenSearch<br>version  |
+|--------              |---                         |---                  |
+| [1.x](https://github.com/opensearch-project/OpenSearch/tree/1.x) | [main](https://github.com/opensearch-project/security/) | [v1.3.0](https://github.com/opensearch-project/OpenSearch/blob/6eda740be744846f7aa0b2674820b5ed9b6be17e/buildSrc/version.properties#L1) |


While I think it would be better to use more recent builds, IMO any update to this guide that make it more usable are for the better, and we can update it afterward.

Signed-off-by: Darshit Chanpura <[email protected]> (cherry picked from commit b6fe0c0)

Signed-off-by: Darshit Chanpura <[email protected]> (cherry picked from commit b6fe0c0) Co-authored-by: Darshit Chanpura <[email protected]>

Signed-off-by: Darshit Chanpura <[email protected]> Signed-off-by: Vasile Negru <[email protected]>

DarshitChanpura requested a review from a team February 1, 2022 23:01

davidlago reviewed Feb 1, 2022

View reviewed changes

davidlago previously approved these changes Feb 2, 2022

View reviewed changes

pc-jedi reviewed Feb 3, 2022

View reviewed changes

hsiang9431-amzn reviewed Feb 3, 2022

View reviewed changes

DarshitChanpura dismissed davidlago’s stale review via f89e282 February 3, 2022 21:55

davidlago previously approved these changes Feb 4, 2022

View reviewed changes

DarshitChanpura dismissed davidlago’s stale review via e51f101 February 4, 2022 17:27

DarshitChanpura commented Feb 4, 2022

View reviewed changes

davidlago previously approved these changes Feb 7, 2022

View reviewed changes

DarshitChanpura dismissed davidlago’s stale review via dae6866 March 18, 2022 14:39

DarshitChanpura force-pushed the dev-guide-update branch from 9e14591 to dae6866 Compare March 18, 2022 14:39

DarshitChanpura force-pushed the dev-guide-update branch from 7017582 to 1643fea Compare June 23, 2022 20:58

DarshitChanpura added 4 commits June 27, 2022 11:03

Updates Dev guide

075924c

Signed-off-by: Darshit Chanpura <[email protected]>

Updates dev guide to reflect changes from PR comments

1609ea0

Signed-off-by: Darshit Chanpura <[email protected]>

Addresses PR comments

249bfc2

Signed-off-by: Darshit Chanpura <[email protected]>

Updates the dev-guide to add version information

bc16209

Signed-off-by: Darshit Chanpura <[email protected]>

DarshitChanpura force-pushed the dev-guide-update branch from 1643fea to bc16209 Compare June 27, 2022 15:03

Merge branch 'main' into dev-guide-update

ed5c07d

peternied approved these changes Jun 27, 2022

View reviewed changes

peternied reviewed Jun 27, 2022

View reviewed changes

cliu123 approved these changes Jun 29, 2022

View reviewed changes

cliu123 merged commit b6fe0c0 into opensearch-project:main Jun 29, 2022

cliu123 added the backport 2.x backport to 2.x branch label Jul 28, 2022

opensearch-trigger-bot bot pushed a commit that referenced this pull request Jul 28, 2022

Updates Dev guide (#897)

3d38f14

Signed-off-by: Darshit Chanpura <[email protected]> (cherry picked from commit b6fe0c0)

opensearch-trigger-bot bot mentioned this pull request Jul 28, 2022

[Backport 2.x] Updates Dev guide #1045

Merged

peternied pushed a commit that referenced this pull request Jul 28, 2022

Updates Dev guide (#897) (#1045)

5cbd26a

Signed-off-by: Darshit Chanpura <[email protected]> (cherry picked from commit b6fe0c0) Co-authored-by: Darshit Chanpura <[email protected]>

spartan2015 pushed a commit to spartan2015/security-dashboards-plugin that referenced this pull request Aug 8, 2022

Updates Dev guide (opensearch-project#897)

a53eab0

Signed-off-by: Darshit Chanpura <[email protected]> Signed-off-by: Vasile Negru <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updates Dev guide #897

Updates Dev guide #897

DarshitChanpura commented Feb 1, 2022 •

edited

Loading

codecov-commenter commented Feb 1, 2022 •

edited

Loading

davidlago Feb 1, 2022

DarshitChanpura Feb 2, 2022

davidlago Feb 1, 2022

DarshitChanpura Feb 2, 2022

pc-jedi Feb 3, 2022

cliu123 Feb 3, 2022

pc-jedi Feb 3, 2022

hsiang9431-amzn Feb 3, 2022

davidlago Feb 3, 2022

hsiang9431-amzn Feb 4, 2022

DarshitChanpura Feb 4, 2022

DarshitChanpura Feb 4, 2022

cliu123 commented Mar 28, 2022 •

edited

Loading

cliu123 commented Mar 28, 2022

DarshitChanpura commented Mar 28, 2022

DarshitChanpura commented Mar 28, 2022 •

edited

Loading

DarshitChanpura commented Mar 28, 2022

cliu123 commented Jun 8, 2022

DarshitChanpura commented Jun 27, 2022

peternied Jun 27, 2022


		As a prerequisite, please follow [the developer guide of the Security Plugin](https://github.com/opensearch-project/security/blob/main/DEVELOPER_GUIDE.md). This will leave you with a running OpenSearch server with security enabled. For the sake of this guide, let's assume the latest versions at the time of writing (`1.3.0-SNAPSHOT` for OpenSearch and OpenSearch Dashboards, and `1.3.0.0-SNAPSHOT` for both backend and frontend (this repo) security plugins.) Update the config file (`config/opensearch.yml`) to look like this one:
		This project is as a plugin of [OpenSearch-Dashboards](**https://github.com/opensearch-project/OpenSearch-Dashboards). It requires an [OpenSearch](https://github.com/opensearch-project/OpenSearch) server running with the [Security](https://github.com/opensearch-project/security) plugin installed. At the time of this writing there is a strict version check between these components, so we recommend running all of them from their respective branches with matching versions (this will also ensure they work well together before we cut a new release.)


		IMPORTANT: Throughout this guide we will be using 1.x branches as our source for all 4 repos (OpenSearch, OpenSearch-Dashboards, security and security-dashboards-plugin).

		> NOTE: If you are following this guide by the dot, please make sure that source code that you compile for OpenSearch project using `./gradlew localDistro` is done from [1.x branch](https://github.com/opensearch-project/OpenSearch/tree/1.x)

Updates Dev guide #897

Updates Dev guide #897

Conversation

DarshitChanpura commented Feb 1, 2022 • edited Loading

Description

Category

Check List

codecov-commenter commented Feb 1, 2022 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cliu123 commented Mar 28, 2022 • edited Loading

cliu123 commented Mar 28, 2022

DarshitChanpura commented Mar 28, 2022

DarshitChanpura commented Mar 28, 2022 • edited Loading

DarshitChanpura commented Mar 28, 2022

cliu123 commented Jun 8, 2022

DarshitChanpura commented Jun 27, 2022

Choose a reason for hiding this comment

DarshitChanpura commented Feb 1, 2022 •

edited

Loading

codecov-commenter commented Feb 1, 2022 •

edited

Loading

cliu123 commented Mar 28, 2022 •

edited

Loading

DarshitChanpura commented Mar 28, 2022 •

edited

Loading