add details about running individual e2e test cases #960
Conversation
LiboYu2
requested review from
roypaulin,
cchen-vertica,
fenic-fawkes,
HaoYang0000 and
qindotguan
as code owners
DEVELOPER.md
Outdated
| > | ||
| BASE_VERTICA_IMG and VERTICA_IMG are used for the upgrade test cases. The BASE_VERTICA_IMG is the base vertica vertion that will be installed. VERTICA_IMG is the vertica version that the base version will be upgraded to. The version in VERTICA_IMG must be higher than that in BASE_VERTICA_IMG. | ||
|
|
||
| VERTICA_DEPLOYMENT_METHOD=vclusterops lets the backend use vcluster package to manage vertica clusters, instead of the legacy admintools. |
There was a problem hiding this comment.
Given we still support admintools, let's say by default its value is admintools and in that case the vertica image must be admintools compatible
DEVELOPER.md
Outdated
| > ```shell | ||
| > unset LICENSE_FILE | ||
| > | ||
| BASE_VERTICA_IMG and VERTICA_IMG are used for the upgrade test cases. The BASE_VERTICA_IMG is the base vertica vertion that will be installed. VERTICA_IMG is the vertica version that the base version will be upgraded to. The version in VERTICA_IMG must be higher than that in BASE_VERTICA_IMG. |
There was a problem hiding this comment.
Could you move the explanation of the environment variables right below the examples mentioned above?
For example:
export VERTICA_DEPLOYMENT_METHOD=vclusterops
VERTICA_DEPLOYMENT_METHOD=vclusterops lets the backend use ...
```shell
export LICENSE_FILE=/file_path/license.key
If the total number of nodes used ...
...
DEVELOPER.md
Outdated
| > ```shell | ||
| > export VERTICA_DEPLOYMENT_METHOD=vclusterops | ||
| > ``` | ||
| VERTICA_DEPLOYMENT_METHOD=vclusterops lets the backend use vcluster package to manage vertica clusters. If it is not set, the default value will be admintools and the vertica image must be admintools compatible. |
There was a problem hiding this comment.
We need to indent the explanation of the environment variables.
DEVELOPER.md
Outdated
| > scripts/push-to-kind.sh -i $VERTICA_IMG | ||
| > scripts/push-to-kind.sh -i $BASE_VERTICA_IMG | ||
| > | ||
| This will speed up test case execution and avoid timeout. |
There was a problem hiding this comment.
This line needs indent as well.
There was a problem hiding this comment.
This line needs to be fixed. It's still in a shell frame.
There was a problem hiding this comment.
It is fixed by the following commit
DEVELOPER.md
Outdated
| > | ||
| > ```shell | ||
| > make setup-minio | ||
| > ``` | ||
| > | ||
| > To set up a different communal endpoint, see [Custom communal endpoints](#custom-communal-endpoints). | ||
| To set up a different communal endpoint, see [Custom communal endpoints](#custom-communal-endpoints). |
There was a problem hiding this comment.
The explanation is currently inside a shell frame. We need to adjust the format. Could you try to remove the symbol ">" from lines 361 to 365? If this works, do the same thing for other env vars below.
There was a problem hiding this comment.
I made the change. It turns out ">" is used to add an indent to all lines in a graph.
|
There is still one comment that needs to be addressed |
That comment was fixed in a commit but I did not reply to that comment. Now all comments are addressed. |
|
If it is not done yet merge the main into this branch. |
Co-authored-by: Roy Paulin <[email protected]>
It's not fixed yet. From your branch, I still see that line is inside a shell frame. |
…ca-kubernetes into VER-96590-doc-for-e2e-test
I noticed it. It is really hard to find a good local md file reviewer. I made another fix. |
Added 3 prerequisite steps for running individual e2e tests:
1 set up minio
2 set up/unset required environmental variables.
3 tune up timeout parameters kuttl-test.yaml