celeborn/mkdocs.yml
Yi Chen c20536e5c5
[CELEBORN-1425][HELM] Add helm chart unit tests to ensure manifests are rendered as expected
### What changes were proposed in this pull request?

Add helm chart unit tests.

### Why are the changes needed?

Unit tests can make resource manifests are rendered as expected with various configurations.

### Does this PR introduce _any_ user-facing change?

No.

### How was this patch tested?

Detailed information about how to run helm chart unit tests can be found here [helm-unittest/helm-unittest](https://github.com/helm-unittest/helm-unittest). First, you need to install helm unit test plugin:

```shell
helm plugin install https://github.com/helm-unittest/helm-unittest.git
```

Then, run helm chart unitt tests as follows:

```shell
$ helm unittest charts/celeborn  --file "tests/**/*_test.yaml" --strict --debug
load_plugins.go:110: [info] file (/Users/chenyi/Library/helm/plugins/helm-acr/completion.yaml) not provided by plugin. No plugin auto-completion possible

### Chart [ celeborn ] charts/celeborn

 PASS  Test Celeborn configmap  charts/celeborn/tests/configmap_test.yaml
 PASS  Test Celeborn master pod monitor charts/celeborn/tests/master/podmonitor_test.yaml
 PASS  Test Celeborn master priority class      charts/celeborn/tests/master/priorityclass_test.yaml
 PASS  Test Celeborn master service     charts/celeborn/tests/master/service_test.yaml
 PASS  Test Celeborn master statefulset charts/celeborn/tests/master/statefulset_test.yaml
 PASS  Test Celeborn worker pod monitor charts/celeborn/tests/worker/podmonitor_test.yaml
 PASS  Test Celeborn worker priority class      charts/celeborn/tests/worker/priorityclass_test.yaml
 PASS  Test Celeborn worker service     charts/celeborn/tests/worker/service_test.yaml
 PASS  Test Celeborn worker statefulset charts/celeborn/tests/worker/statefulset_test.yaml

Charts:      1 passed, 1 total
Test Suites: 9 passed, 9 total
Tests:       48 passed, 48 total
Snapshot:    0 passed, 0 total
Time:        183.011375ms

```

Closes #2511 from ChenYi015/helm-unittest.

Authored-by: Yi Chen <github@chenyicn.net>
Signed-off-by: Cheng Pan <chengpan@apache.org>
2024-05-15 19:17:30 +08:00

99 lines
3.2 KiB
YAML

#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
site_name: Apache Celeborn™
repo_name: apache/celeborn
repo_url: https://gitbox.apache.org/repos/asf/celeborn.git
plugins:
- search
- macros
- include-markdown:
opening_tag: "{!"
closing_tag: "!}"
theme:
font: false
name: material
language: en
logo: assets/logo/celeborn-1.svg
favicon: assets/logo/celeborn-2.svg
features:
- navigation.indexes
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.tracking
markdown_extensions:
- admonition
- attr_list
- def_list
- md_in_html
- admonition
- pymdownx.details
- pymdownx.superfences
extra:
social:
- icon: fontawesome/brands/github
copyright: >
<br>
Copyright © 2022-2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.
<a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy Policy<a/><br>
<br>
Apache Celeborn™, Apache, and the Apache feather logo are trademarks or registered trademarks of The Apache Software Foundation.<br>
<br>
Please visit <a href="https://www.apache.org/">Apache Software Foundation</a> for more details.<br>
<br>
nav:
- QuickStart: README.md
- Deployment:
- Overview: deploy.md
- Kubernetes: deploy_on_k8s.md
- Monitoring: monitoring.md
- Security: security.md
- Quota Management: quota_management.md
- Upgrading: upgrading.md
- Ratis Shell: celeborn_ratis_shell.md
- Cluster Planning: cluster_planning.md
- Configuration: configuration/index.md
- Migration Guide: migration.md
- Developers Doc:
- Overview: developers/overview.md
- Master:
- Overview: developers/master.md
- Slots Allocation: developers/slotsallocation.md
- Worker:
- Overview: developers/worker.md
- Storage: developers/storage.md
- Traffic Control: developers/trafficcontrol.md
- JVM Profiler: developers/jvmprofiler.md
- Client:
- Overview: developers/client.md
- LifecycleManager: developers/lifecyclemanager.md
- ShuffleClient: developers/shuffleclient.md
- Configuration: developers/configuration.md
- Fault Tolerant: developers/faulttolerant.md
- Worker Exclusion: developers/workerexclusion.md
- Integrating Celeborn: developers/integrate.md
- SBT Build: developers/sbt.md
- Gluten Support: developers/glutensupport.md
- Helm Charts: developers/helm-charts.md