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

Update run_experiment document #699

Merged
merged 6 commits into from
Aug 3, 2020

Conversation

cwen0
Copy link
Member

@cwen0 cwen0 commented Jul 14, 2020

Signed-off-by: cwen0 [email protected]

What problem does this PR solve?

What is changed and how does it work?

Check List

Tests

  • Unit test
  • E2E test
  • Manual test (add detailed scripts or steps below)
  • No code

Code changes

  • Has Go code change
  • Has CI related scripts change
  • Has Terraform scripts change

Side effects

  • Breaking backward compatibility

Related changes

  • Need to update the documentation

Does this PR introduce a user-facing change?

NONE

@cwen0 cwen0 added the documentation Improvements or additions to documentation label Jul 14, 2020
@codecov-commenter
Copy link

Codecov Report

Merging #699 into master will decrease coverage by 1.24%.
The diff coverage is 36.12%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #699      +/-   ##
==========================================
- Coverage   55.78%   54.53%   -1.25%     
==========================================
  Files          68       69       +1     
  Lines        4383     4652     +269     
==========================================
+ Hits         2445     2537      +92     
- Misses       1768     1926     +158     
- Partials      170      189      +19     
Impacted Files Coverage Δ
api/v1alpha1/networkchaos_types.go 22.98% <ø> (ø)
api/v1alpha1/podchaos_types.go 37.14% <ø> (ø)
controllers/networkchaos/netem/utils.go 0.00% <0.00%> (ø)
pkg/chaosdaemon/netlink_linux.go 0.00% <0.00%> (ø)
pkg/chaosdaemon/stress_server_linux.go 0.00% <0.00%> (ø)
pkg/chaosdaemon/tc_linux.go 42.85% <0.00%> (ø)
pkg/utils/chaosdaemon.go 51.21% <0.00%> (ø)
pkg/utils/grpc.go 0.00% <0.00%> (ø)
pkg/webhook/inject/inject.go 73.49% <0.00%> (-0.68%) ⬇️
pkg/chaosdaemon/util.go 72.48% <9.09%> (-10.60%) ⬇️
... and 15 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 1781506...f94f4f2. Read the comment docs.

@cwen0 cwen0 requested a review from dcalvin July 14, 2020 13:19
### Pause a chaos experiment

```bash
kubectl annotate networkchaos web-show-network-delay experiment.pingcap.com/pause=true
Copy link
Contributor

Choose a reason for hiding this comment

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

should update to experiment.chaos-mesh.org/pause


> **Note:**
>
> If the web-show is deployed on the server, you need use the host ip to access the application.

## Step 2: Define the experiment configuration file

The chaos experiment configuration is defined in a YAML file. You need to create your own experiment configuration file based on the available fields in the sample below:

```yaml
apiVersion: pingcap.com/v1alpha1
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
apiVersion: pingcap.com/v1alpha1
apiVersion: chaos-mesh.org/v1alpha1

cwen0 added 2 commits August 3, 2020 10:21
Signed-off-by: cwen0 <[email protected]>
Signed-off-by: cwen0 <[email protected]>
Copy link
Contributor

@WangXiangUSTC WangXiangUSTC left a comment

Choose a reason for hiding this comment

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

LGTM

@ti-srebot
Copy link
Contributor

@WangXiangUSTC,Thanks for your review. However, LGTM is restricted to Reviewers or higher roles.See the corresponding SIG page for more information. Related SIGs: chaos-mesh(slack).

Copy link
Member

@fewdan fewdan left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@zhouqiang-cl zhouqiang-cl left a comment

Choose a reason for hiding this comment

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

LGTM

@zhouqiang-cl
Copy link
Contributor

/merge

@ti-srebot
Copy link
Contributor

/run-all-tests

@ti-srebot
Copy link
Contributor

@cwen0 merge failed.

@cwen0
Copy link
Member Author

cwen0 commented Aug 3, 2020

/merge

@ti-srebot
Copy link
Contributor

/run-all-tests

@ti-srebot
Copy link
Contributor

@cwen0 merge failed.

@cwen0
Copy link
Member Author

cwen0 commented Aug 3, 2020

/merge

@ti-srebot
Copy link
Contributor

Your auto merge job has been accepted, waiting for:

  • 774

@ti-srebot
Copy link
Contributor

/run-all-tests

@ti-srebot ti-srebot merged commit 1f441b8 into chaos-mesh:master Aug 3, 2020
sjwsl pushed a commit to sjwsl/chaos-mesh that referenced this pull request May 6, 2021
* Update run_experiment document

Signed-off-by: cwen0 <[email protected]>

* make clean

Signed-off-by: cwen0 <[email protected]>

* address comments

Signed-off-by: cwen0 <[email protected]>

Co-authored-by: ti-srebot <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation status/can-merge status/LGT2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants