diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml index 8bed5b00..d3296207 100644 --- a/.github/workflows/benchmark.yml +++ b/.github/workflows/benchmark.yml @@ -6,6 +6,12 @@ permissions: on: push: branches: "main" + paths: + - '.github/workflows/benchmark*.yml' + - 'Cargo.toml' + - 'Cargo.lock' + - 'benches/**' + - 'src/**' env: CARGO_TERM_COLOR: always diff --git a/.github/workflows/benchmark_fork_run.yml b/.github/workflows/benchmark_fork_run.yml index 3e27c2b1..eb8b70bc 100644 --- a/.github/workflows/benchmark_fork_run.yml +++ b/.github/workflows/benchmark_fork_run.yml @@ -3,6 +3,11 @@ name: "Run Benchmarks" on: pull_request: types: [opened, reopened, edited, synchronize] + paths: + - '.github/workflows/benchmark*.yml' + - 'Cargo.toml' + - 'benches/**' + - 'src/**' jobs: benchmark_fork_pr_branch: diff --git a/.github/workflows/benchmark_pr.yml b/.github/workflows/benchmark_pr.yml index 3393c856..1df0ac6e 100644 --- a/.github/workflows/benchmark_pr.yml +++ b/.github/workflows/benchmark_pr.yml @@ -5,6 +5,12 @@ permissions: on: pull_request: + branches: "main" + paths: + - '.github/workflows/benchmark*.yml' + - 'Cargo.toml' + - 'benches/**' + - 'src/**' env: CARGO_TERM_COLOR: always diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 727e96dd..0fa7c4a6 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -8,6 +8,12 @@ on: branches: [ "main" ] pull_request: branches: [ "main" ] + paths: + - '.github/workflows/ci*.yml' + - 'Cargo.toml' + - 'Cargo.lock' + - 'benches/**' + - 'src/**' env: CARGO_TERM_COLOR: always diff --git a/.github/workflows/container-build.yml b/.github/workflows/container-build.yml index dfd4c224..5b4cebf9 100644 --- a/.github/workflows/container-build.yml +++ b/.github/workflows/container-build.yml @@ -10,7 +10,7 @@ on: - 'Cargo.lock' - '.github/workflows/container-build.yml' - '.github/workflows/container-publish.yml' - - 'keystone/**' + - 'src/**' - 'Dockerfile' - '.dockerignore' diff --git a/.github/workflows/mdbook.yaml b/.github/workflows/mdbook.yaml index 157b9172..430771d5 100644 --- a/.github/workflows/mdbook.yaml +++ b/.github/workflows/mdbook.yaml @@ -7,6 +7,11 @@ name: Deploy mdBook site to Pages on: pull_request: branches: ["main" ] + paths: + - '.github/workflows/mdbook*.yml' + - 'Cargo.toml' + - 'Cargo.lock' + - 'doc/**' push: branches: ["main"] # Allows you to run this workflow manually from the Actions tab diff --git a/README.md b/README.md index 16099243..00925157 100644 --- a/README.md +++ b/README.md @@ -61,10 +61,18 @@ We believe this approach allows the best of both worlds: the trusted maturity of Keystone’s Python code-base, combined with the modern, high-safety, high-performance capabilities of Rust where they matter most. +## Documentation + +Project documentation can be found [here](https://openstack-experimental.github.io/keystone). +It is a work in progress. Target is to provide a comprehensive documentation of +the new functionality and provide missing insides to the python Keystone +functionality with Architecture Decision Records, Specs, Thread analysis and +many more. + ## Config -Keystone config is being read and the main goal is to have possibility to -simply reuse Keystone config with no changes. +It is supposed, that the configuration for the python Keystone can be used +without changes also for the rust implementation. ## Api + OpenAPI @@ -74,6 +82,7 @@ matches the implementation. ## Database Sea-ORM is being used to access database. PostgreSQL and MySQL are supported. +Functional tests [would] test the compatibility. ## Load test @@ -96,13 +105,8 @@ possession of the binary is as easy as `keystone -c etc/keystone.conf -vv` Alternatively you can try it with `docker compose -f docker-compose.yaml up`. -## Documentation - -Comprehensive (as much as it can be at the current stage) is available -[here](https://gtema.github.io/keystone). - ## Talks Detailed introduction of the project was given as -[ALASCA tech talk](https://www.youtube.com/watch?v=0Hx4Q22ZNFU). -[OpenStack Summit 2025](https://www.youtube.com/watch?v=XOHYqE2HRw4&list=PLKqaoAnDyfgr91wN_12nwY321504Ctw1s&index=30) +* [ALASCA tech talk](https://www.youtube.com/watch?v=0Hx4Q22ZNFU) +* [OpenStack Summit 2025](https://www.youtube.com/watch?v=XOHYqE2HRw4&list=PLKqaoAnDyfgr91wN_12nwY321504Ctw1s&index=30) diff --git a/doc/src/install.md b/doc/src/install.md index a5408343..5092ea64 100644 --- a/doc/src/install.md +++ b/doc/src/install.md @@ -93,5 +93,4 @@ opa run -s policies **NOTE:** by default OPA process listens on the localhost only what lead to unavailability to expose it between containers. Please use `-a 0.0.0.0:8181` to - start listening on all interfaces.