-
Notifications
You must be signed in to change notification settings - Fork 15
/
Copy pathmkdocs.yml
159 lines (159 loc) · 7.57 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
site_name: Projectsveltos Documentation
copyright: Copyright © 2022 projectsveltos. All Rights Reserved.
site_description: 'Sveltos is a lightweight application designed to manage add-ons in hundreds of clusters. Projectsveltos extends functionality of Cluster API by providing a solution for managing the installation, configuration, upgrade, and deletion of kubernetes cluster add-ons using Helm charts and/or Kubernetes resource YAMLs. Projectsveltos supports multi-tenancy allowing platform admins to easily grant permissions to tenant admins.'
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences
- attr_list
- md_in_html
- footnotes
- pymdownx.critic
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
nav:
- Projectsveltos: 'index.md'
- Use Cases:
- Platform Administrators, Multicloud and Add-ons: 'use_cases/use_case_platform_admin_multicloud.md'
- Platform Administrators and Multitenancy: 'use_cases/use_case_multitenancy.md'
- Sveltos and Flux Integration: 'use_cases/use_case_flux_integration.md'
- Getting Started:
- Installation:
- Local Playground: 'getting_started/install/quick_start.md'
- Installation: 'getting_started/install/install.md'
- Air-Gapped Installation: 'getting_started/install/air_gapped_installation.md'
- Dashboard: 'getting_started/install/dashboard.md'
- Sveltos-Grafana Dashboard: 'getting_started/install/grafanadashboard.md'
- Telemetry: 'getting_started/install/telemetry.md'
- Sveltosctl:
- Sveltosctl: 'getting_started/sveltosctl/sveltosctl.md'
- Visibility: 'getting_started/sveltosctl/visibility.md'
- Dry Run: 'getting_started/sveltosctl/dryrun.md'
- Snapshot: 'getting_started/sveltosctl/snapshot.md'
- Register Clusters:
- Register Cluster: 'register/register-cluster.md'
- Register Management Cluster: 'register/register_management_cluster.md'
- Register Claudie Powered Clusters: 'register/register_claudie_cluster.md'
- Cluster Maintenance Window: 'register/cluster_maintenance_window.md'
- Automatic Token Renewal: 'register/token-renewal.md'
- Deploy add-ons and applications:
- Distribute Add-ons: 'addons/addons.md'
- Deploy Helm Charts: 'addons/helm_charts.md'
- Deploy YAML/JSON Kubernetes manifests: 'addons/raw_yaml.md'
- Example Flux Sources: 'addons/example_flux_sources.md'
- Deploy Kustomize Kubernetes manifests: 'addons/kustomize.md'
- ClusterProfile Example: 'addons/combining_all.md'
- Deep dive into ClusterProfiles: 'addons/clusterprofile.md'
- Deep dive into Profiles: 'addons/profile.md'
- Templating:
- Introduction to Templates: 'template/intro_template.md'
- Resource Manipulating Functions - Examples: 'template/examples.md'
- Helm Charts and Resource Templates - Examples: 'template/template_generic_examples.md'
- Generating Sveltos Configurations with Sveltos: 'template/generate_sveltos_configuration.md'
- Support for Carvel ytt: 'template/ytt_extension.md'
- Support for Jsonnet: 'template/jsonnet_extension.md'
- Example Mutlicluster Iteration and Deployment: 'template/example_multicluster_iteration_template.md'
- Example Integration with Crossplane: 'template/crossplane.md'
- Example Integration with External Secret Management: 'template/external_secret.md'
- Example Integrate Sveltos with own controller: 'template/bring_your_own_controller.md'
- Resource Deployment Order:
- Profile Resource Deployment Order: 'deployment_order/manifest_order.md'
- Profile dependsOn field: 'deployment_order/depends_on.md'
- Profile dependsOn and validateHealths: 'deployment_order/depends_on_with_health_checks.md'
- Profile Tiers: 'deployment_order/tiers.md'
- Add-on rollout strategy: 'deployment_order/rolling_update_strategy.md'
- Scenario 'Event Framework and Resource Deployment': 'deployment_order/order_with_events.md'
- Features:
- Dependency Management: 'features/dependency-management.md'
- DryRun: 'features/dryrun.md'
- Configuration Drift detection: 'features/configuration_drift.md'
- Post Renderer Patches: 'features/post-renderer-patches.md'
- Dynamic Cluster Management and Failover: 'features/set.md'
- Rolling Upgrade Deployment, StatefulSet, DaemonSet: 'features/rolling_upgrade.md'
- Cluster Classification: 'features/labels_management.md'
- Multi-tenancy:
- Full Isolation: 'features/multi-tenancy-full-isolation.md'
- Tenants Sharing Clusters: 'features/multi-tenancy-sharing-cluster.md'
- Tech Support: 'features/techsupport.md'
- Event Framework:
- Automatically deploy Add-ons upon specific cluster events.: 'events/addon_event_deployment.md'
- Templating: 'events/generators.md'
- Replicate Secret: 'events/secret_distribution.md'
- Example DB as a Service: 'events/db-as-a-service.md'
- Example Managed Services: 'events/managed-services.md'
- Example Service Event Trigger: 'events/example_service_event_trigger.md'
- Example API Gateway with Contour: 'events/example_api_gateway_contour.md'
- Example Cross-cluster Configuration: 'events/example_cross_cluster_configuration.md'
- Example Loadbalancer: 'events/example_loadbalancer.md'
- Cluster Observability:
- Notifications: 'observability/notifications.md'
- Examples for Slack, Teams, Webex, Discord, Telegram, SMTP Notifications and k8s events: 'observability/example_addon_notification.md'
- Example Slack Notification for Pods in crashloopbackoff: 'observability/example_crashloopbackoff_notification.md'
- Example Deployment Health Notification: 'observability/example_deployment_health_notification.md'
- Example Detect Degrade Certificates Notification: 'observability/example_degrade_certificate_notification.md'
- Example CIS Scan with Kube-bench: 'observability/example_cis_scan.md'
- Display Resources: 'observability/display_resources.md'
- Cross-Resource Evaluation: 'observability/different_resources.md'
- Scalability:
- Vertical Scaling: 'scalability/configuration.md'
- Horizontal Scaling: 'scalability/sharding.md'
- Help and Tutorials:
- Troubleshooting: 'help_and_tutorials/troubleshooting.md'
- Blogs and videos: 'blogs.md'
theme:
features:
- content.code.copy
- search.share
- navigation.footer
- navigation.instant.progress
- content.code.annotate
name: material
logo: assets/logo.png
palette:
- scheme: default
primary: light blue
accent: blue
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- scheme: slate
primary: light blue
accent: blue
toggle:
icon: material/brightness-4
name: Switch to light mode
repo_url: https://github.com/projectsveltos
repo_name: projectsveltos
extra:
social:
- icon: fontawesome/solid/house
link: https://sveltos.projectsveltos.io/
name: Projectsveltos website
- icon: fontawesome/brands/twitter
link: https://twitter.com/projectsveltos
name: Projectsveltos on Twitter
- icon: fontawesome/brands/slack
link: https://join.slack.com/t/projectsveltos/shared_invite/zt-1hraownbr-W8NTs6LTimxLPB8Erj8Q6Q
name: Projectsveltos Slack Channel
- icon: fontawesome/brands/github
link: https://github.com/projectsveltos
name: Projectsveltos GitHub Org Page
- icon: fontawesome/brands/medium
link: https://medium.com/@gianluca.mardente
extra_css:
- stylesheets/extra.css
plugins:
- search