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.

Sign up for GitHub

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

Jump to bottom

Updating documentation and charts #453

Merged
merged 14 commits into from
Sep 23, 2020
Merged

Updating documentation and charts #453

merged 14 commits into from
Sep 23, 2020

Conversation

SrishT
Copy link
Contributor

@SrishT SrishT commented Sep 22, 2020

Signed-off-by: SrishT Srishti.Thakkar@dell.com

Change log description

Updates the operator documentation to reflect the changes in helm commands after the charts have been published to http://charts.pravega.io.

SrishT added 3 commits September 22, 2020 05:07
Updating documentation and charts
f7a9efb 
Signed-off-by: SrishT <Srishti.Thakkar@dell.com>
Updating documentation and charts
bd2a7d6 
Signed-off-by: SrishT <Srishti.Thakkar@dell.com>
Updating documentation and charts
53225b6 
Signed-off-by: SrishT <Srishti.Thakkar@dell.com>
@SrishT SrishT marked this pull request as ready for review September 22, 2020 11:10
Updating documentation and charts
e1fa07c 
Signed-off-by: SrishT <Srishti.Thakkar@dell.com>
@codecov-commenter
Copy link

codecov-commenter commented Sep 22, 2020 •
edited
Loading

Codecov Report

Merging #453 into master will decrease coverage by 0.82%.
The diff coverage is 50.84%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #453      +/-   ##
==========================================
- Coverage   76.11%   75.29%   -0.83%     
==========================================
  Files          14       15       +1     
  Lines        3320     3068     -252     
==========================================
- Hits         2527     2310     -217     
+ Misses        705      669      -36     
- Partials       88       89       +1
Impacted Files Coverage Δ
pkg/apis/pravega/v1alpha1/bookkeeper.go 100.00% <ø> (ø)
pkg/apis/pravega/v1alpha1/pravega.go 100.00% <ø> (ø)
pkg/apis/pravega/v1alpha1/pravegacluster_types.go 90.74% <ø> (+0.26%) ⬆️
pkg/apis/pravega/v1alpha1/status.go 100.00% <ø> (ø)
pkg/apis/pravega/v1beta1/pravega.go 97.36% <ø> (-0.17%) ⬇️
pkg/apis/pravega/v1beta1/status.go 98.00% <ø> (-0.42%) ⬇️
pkg/util/zookeeper_util.go 10.81% <10.81%> (ø)
...roller/pravegacluster/pravegacluster_controller.go 60.90% <63.63%> (-1.31%) ⬇️
pkg/apis/pravega/v1beta1/pravegacluster_types.go 22.73% <64.58%> (+7.69%) ⬆️
pkg/controller/pravega/pravega_controller.go 100.00% <100.00%> (ø)
... and 18 more

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 282aa7d...3d68f53. Read the comment docs.

Ranganaths8
Ranganaths8 approved these changes Sep 22, 2020
View reviewed changes
Copy link

@Ranganaths8 Ranganaths8 left a comment

Choose a reason for hiding this comment

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

approved

README.md Outdated
@@ -85,7 +85,7 @@ $ kubectl create -f ./example/pvc-tier2.yaml

#### Install a Pravega cluster

To understand how to deploy a pravega cluster using helm, refer to [this](charts/zookeeper#installing-the-chart).
Copy link

Choose a reason for hiding this comment

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

why was this previously zookeeper and now changed to pravega?

Prabhaker24
Prabhaker24 suggested changes Sep 22, 2020
View reviewed changes
README.md

Verify that the cluster instances and its components are being created.
Once the pravega cluster with release name `bar` has been created, use the following command to verify that the cluster instances and its components are being created.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we change the default name of pravegacluster release name to "pravega" as that's what is given as default pravega name in configmap for bookkeeper by default.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

By giving a different release name, we are able to show that release name and cluster name might not always be the same

Copy link
Contributor

Choose a reason for hiding this comment

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

I know that but in the bookkeeper configmap the name for pravega cluster is pravega so for a user deploying for the first time this will create an issue if he deploys pravega with any other release name other than pravega.

anishakj
anishakj approved these changes Sep 22, 2020
View reviewed changes
Copy link
Contributor

@anishakj anishakj left a comment

Choose a reason for hiding this comment

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

LGTM

SrishT added 10 commits September 23, 2020 02:07
Updating documentation and charts
3e3c394 
Signed-off-by: SrishT <Srishti.Thakkar@dell.com>
Updating documentation and charts
6c82783 
Signed-off-by: SrishT <Srishti.Thakkar@dell.com>
Updating documentation and charts
f17241d 
Signed-off-by: SrishT <Srishti.Thakkar@dell.com>
Updating documentation and charts
284a6e2 
Signed-off-by: SrishT <Srishti.Thakkar@dell.com>
Updating documentation and charts
1eda765 
Signed-off-by: SrishT <Srishti.Thakkar@dell.com>
Updating documentation and charts
4d18a8d 
Signed-off-by: SrishT <Srishti.Thakkar@dell.com>
Documentation update
885840b 
Signed-off-by: SrishT <Srishti.Thakkar@dell.com>
Documentation update
49a3e1b 
Signed-off-by: SrishT <Srishti.Thakkar@dell.com>
Documentation update
f545899 
Signed-off-by: SrishT <Srishti.Thakkar@dell.com>
Documentation update
3d68f53 
Signed-off-by: SrishT <Srishti.Thakkar@dell.com>
Prabhaker24
Prabhaker24 approved these changes Sep 23, 2020
View reviewed changes
Copy link
Contributor

@Prabhaker24 Prabhaker24 left a comment

Choose a reason for hiding this comment

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

LGTM

@anishakj anishakj merged commit 4725943 into master Sep 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Ranganaths8 Ranganaths8 Ranganaths8 approved these changes

@Prabhaker24 Prabhaker24 Prabhaker24 approved these changes

@anishakj anishakj anishakj approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@SrishT @codecov-commenter @anishakj @Prabhaker24 @Ranganaths8