Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
wip - docs
Browse files Browse the repository at this point in the history
drmorr0 committed Jun 26, 2024
1 parent fe18047 commit a309554
Showing 5 changed files with 16 additions and 25 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -36,6 +36,7 @@ rstest = { version = "0.18.2", optional = true }

anyhow = { version = "1.0.75", features = ["backtrace"] }
async-recursion = "1.0.5"
async-trait = "0.1.80"
bytes = "1.5.0"
chrono = "0.4.26"
clap = { version = "4.3.21", features = ["cargo", "derive", "string"] }
@@ -62,7 +63,6 @@ tracing = "0.1.37"
tracing-log = "0.1.3"
tracing-subscriber = { version = "0.3.17", features = ["env-filter"] }
url = "2.4.1"
async-trait = "0.1.80"

[dependencies.kube]
version = "0.85.0"
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -36,14 +36,14 @@ This package provides the following components:

## Documentation

Full [documentation for SimKube](https://appliedcomputing.io/simkube/index.html) is available on Applied
Full [documentation for SimKube](https://appliedcomputing.io/simkube/) is available on Applied
Computing's website. Here are some quick links to select topics:

- [Installation](https://appliedcomputing.io/simkube/docs/intro/installation.html)
- [Autoscaling](http://appliedcomputing.io/simkube/docs/adv/autoscaling.html)
- [Metrics Collection](http://appliedcomputing.io/simkube/docs/adv/metrics.html)
- [Component Reference](http://appliedcomputing.io/simkube/docs/components/sk-ctrl.html)
- [Developing SimKube](http://appliedcomputing.io/simkube/docs/dev/contributing.html)
- [Installation](https://appliedcomputing.io/simkube/docs/intro/installation/)
- [Autoscaling](http://appliedcomputing.io/simkube/docs/adv/autoscaling/)
- [Metrics Collection](http://appliedcomputing.io/simkube/docs/adv/metrics/)
- [Component Reference](http://appliedcomputing.io/simkube/docs/components/sk-ctrl/)
- [Developing SimKube](http://appliedcomputing.io/simkube/docs/dev/contributing/)

## Contributing

18 changes: 2 additions & 16 deletions docs/components/skctl.md
Original file line number Diff line number Diff line change
@@ -7,22 +7,8 @@ template: docs.html

`skctl` is the CLI for interacting with SimKube. It's not required to use but it will make your life a lot easier.

```
command-line app for running simulations with SimKube
Usage: skctl <COMMAND>
Commands:
crd print SimKube CRDs
delete delete a simulation
export export simulation trace data
run run a simulation
snapshot take a point-in-time snapshot of a cluster (does not require sk-tracer to be running)
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
-V, --version Print version
```bash exec="on" result="plaintext"
skctl --help
```

## skctl crd
8 changes: 6 additions & 2 deletions lib/testutils/fake.rs
Original file line number Diff line number Diff line change
@@ -7,7 +7,7 @@ use httpmock::{
use serde_json::json;

pub struct MockServerBuilder {
pub server: MockServer,
server: MockServer,
handlers: Vec<Box<dyn Fn(When, Then)>>,
mock_ids: Vec<usize>,
}
@@ -61,12 +61,16 @@ impl MockServerBuilder {
when.matches(print_req);
});
}

pub fn url(&self) -> http::Uri {
http::Uri::try_from(self.server.url("/")).unwrap()
}
}

pub fn make_fake_apiserver() -> (MockServerBuilder, kube::Client) {
let builder = MockServerBuilder::new();
let config = kube::Config {
cluster_url: http::Uri::try_from(builder.server.url("/")).unwrap(),
cluster_url: builder.url(),
default_namespace: "default".into(),
root_cert: None,
connect_timeout: None,
1 change: 1 addition & 0 deletions tracer/main.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
mod errors;

use std::ops::Deref;
use std::sync::{
Arc,

0 comments on commit a309554

Please sign in to comment.