Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 6258fe0
Showing
228 changed files
with
12,317 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
afterall | ||
aks |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# GitHub Action to automate the identification of common misspellings in text files. | ||
# https://github.com/codespell-project/actions-codespell | ||
# https://github.com/codespell-project/codespell | ||
name: codespell | ||
on: [push, pull_request] | ||
permissions: | ||
contents: read | ||
|
||
jobs: | ||
codespell: | ||
name: Check for spelling errors | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Harden Runner | ||
uses: step-security/harden-runner@128a63446a954579617e875aaab7d2978154e969 # v2.4.0 | ||
with: | ||
egress-policy: audit | ||
|
||
- uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3 | ||
- uses: codespell-project/actions-codespell@94259cd8be02ad2903ba34a22d9c13de21a74461 # master | ||
with: | ||
check_filenames: true | ||
skip: ./.git,./.github/workflows/codespell.yaml,.git,*.png,*.jpg,*.svg,*.sum,./vendor,go.sum,testdata | ||
ignore_words_file: .codespellignore |
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
/* | ||
Add styles or override variables from the theme here. | ||
*/ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,171 @@ | ||
title = "Cloud Provider Azure" | ||
|
||
publishDir = "public" | ||
enableRobotsTXT = true | ||
|
||
# Will give values to .Lastmod etc. | ||
enableGitInfo = true | ||
|
||
# Language settings | ||
contentDir = "content/en" | ||
defaultContentLanguage = "en" | ||
defaultContentLanguageInSubdir = false | ||
# Useful when translating. | ||
enableMissingTranslationPlaceholders = true | ||
|
||
disableKinds = ["taxonomy", "taxonomyTerm"] | ||
[params.taxonomy] | ||
# Highlighting config | ||
pygmentsCodeFences = true | ||
pygmentsUseClasses = false | ||
# Use the new Chroma Go highlighter in Hugo. | ||
pygmentsUseClassic = false | ||
#pygmentsOptions = "linenos=table" | ||
# See https://help.farbox.com/pygments.html | ||
pygmentsStyle = "tango" | ||
|
||
# Configure how URLs look like per section. | ||
[permalinks] | ||
blog = "/:section/:year/:month/:day/:slug/" | ||
|
||
## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday | ||
[blackfriday] | ||
angledQuotes = false | ||
hrefTargetBlank = true | ||
latexDashes = true | ||
plainIDAnchors = true | ||
|
||
# Image processing configuration. | ||
[imaging] | ||
anchor = "smart" | ||
quality = 75 | ||
resampleFilter = "CatmullRom" | ||
|
||
[services] | ||
[services.googleAnalytics] | ||
# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback]. | ||
id = "UA-00000000-0" | ||
|
||
# Language configuration | ||
|
||
[languages] | ||
[languages.en] | ||
description = "Cloud Provider Azure" | ||
languageName = "English" | ||
title = "Cloud Provider Azure" | ||
# Weight used for sorting. | ||
weight = 1 | ||
|
||
[markup] | ||
[markup.goldmark] | ||
[markup.goldmark.renderer] | ||
unsafe = true | ||
[markup.highlight] | ||
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html | ||
style = "tango" | ||
# Uncomment if you want your chosen highlight style used for code blocks without a specified language | ||
# guessSyntax = "true" | ||
|
||
# Everything below this are Site Params | ||
|
||
[params] | ||
copyright = "The Kubernetes Authors" | ||
privacy_policy = "" | ||
|
||
# First one is picked as the Twitter card image if not set on page. | ||
# images = ["images/project-illustration.png"] | ||
|
||
# Menu title if your navbar has a versions selector to access old versions of your site. | ||
# This menu appears only if you have at least one [params.versions] set. | ||
version_menu = "Releases" | ||
|
||
# Flag used in the "version-banner" partial to decide whether to display a | ||
# banner on every page indicating that this is an archived version of the docs. | ||
# Set this flag to "true" if you want to display the banner. | ||
archived_version = false | ||
|
||
# The version number for the version of the docs represented in this doc set. | ||
# Used in the "version-banner" partial to display a version number for the | ||
# current doc set. | ||
version = "0.0" | ||
|
||
# A link to latest version of the docs. Used in the "version-banner" partial to | ||
# point people to the main doc site. | ||
url_latest_version = "https://cloud-provider-azure.sigs.k8s.io" | ||
|
||
github_branch= "master" | ||
# Repository configuration (URLs for in-page links to opening issues and suggesting changes) | ||
github_repo = "https://github.com/kubernetes-sigs/cloud-provider-azure" | ||
# An optional link to a related project repo. For example, the sibling repository where your product code lives. | ||
github_project_repo = "https://github.com/kubernetes-sigs/cloud-provider-azure" | ||
|
||
# Specify a value here if your content directory is not in your repo's root directory | ||
github_subdir = "site" | ||
|
||
# Google Custom Search Engine ID. Remove or comment out to disable search. | ||
# gcs_engine_id = "011737558837375720776:fsdu1nryfng" | ||
|
||
# Enable Algolia DocSearch | ||
algolia_docsearch = false | ||
|
||
# Enable Lunr.js offline search | ||
offlineSearch = true | ||
|
||
# User interface configuration | ||
[params.ui] | ||
# Enable to show the side bar menu in its compact state. | ||
sidebar_menu_compact = false | ||
# Set to true to disable breadcrumb navigation. | ||
breadcrumb_disable = false | ||
# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled) | ||
sidebar_search_disable = false | ||
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top nav bar | ||
navbar_logo = true | ||
# Set to true to disable the About link in the site footer | ||
footer_about_disable = false | ||
|
||
# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events. | ||
# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set. | ||
# If you want this feature, but occasionally need to remove the "Feedback" section from a single page, | ||
# add "hide_feedback: true" to the page's front matter. | ||
[params.ui.feedback] | ||
enable = true | ||
# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful). | ||
no = 'Sorry to hear that. Please <a href="https://github.com/kubernetes-sigs/cloud-provider-azure/issues/new">tell us how we can improve</a>.' | ||
yes = 'Glad to hear it! Please <a href="https://github.com/kubernetes-sigs/cloud-provider-azure/issues/new">tell us how we can improve</a>.' | ||
|
||
# Adds a reading time to the top of each doc. | ||
# If you want this feature, but occasionally need to remove the Reading time from a single page, | ||
# add "hide_readingtime: true" to the page's front matter | ||
[params.ui.readingtime] | ||
enable = false | ||
|
||
[params.links] | ||
# End user relevant links. These will show up on left side of footer and in the community page if you have one. | ||
[[params.links.user]] | ||
desc = "Discussion and help from your fellow users" | ||
icon = "fa fa-envelope" | ||
name = "Google Group" | ||
url = "https://groups.google.com/forum/#!forum/kubernetes-sig-cloud-provider" | ||
# Developer relevant links. These will show up on right side of footer and in the community page if you have one. | ||
[[params.links.developer]] | ||
desc = "Development takes place here!" | ||
icon = "fab fa-github" | ||
name = "GitHub" | ||
url = "https://github.com/kubernetes-sigs/cloud-provider-azure" | ||
|
||
[module] | ||
# uncomment line below for temporary local development of module | ||
# replacements = "github.com/google/docsy -> ../../docsy" | ||
[module.hugoVersion] | ||
extended = true | ||
min = "0.104.3" | ||
[[module.imports]] | ||
path = "github.com/google/docsy" | ||
disable = false | ||
[[module.imports]] | ||
path = "github.com/google/docsy/dependencies" | ||
disable = false | ||
|
||
[outputs] | ||
section = [ "HTML", "RSS", "print" ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
baseURL = "https://kubernetes-sigs.github.io/cloud-provider-azure/" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
baseURL = "https://cloud-provider-azure.sigs.k8s.io" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
title: FAQ | ||
linkTitle: FAQ | ||
type: docs | ||
menu: | ||
main: | ||
weight: 40 | ||
--- | ||
|
||
## What is Cloud Provider Azure? | ||
|
||
A Kubernetes `Cloud Provider` consists of two parts: a provider-specified `cloud-controller-manager` (or `kube-controller-manager` for in-tree version) and a provider-specified implementation of Kubernetes [cloud provider interface](https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/cloud-provider/cloud.go). Currently, the Azure `cloud-controller-manager` is outside of [Kubernetes repo](https://github.com/kubernetes/kubernetes) and the cloud provider interface implementation is in `pkg/provider`. | ||
|
||
The `cloud-controller-manager` is a Kubernetes [control plane](https://kubernetes.io/docs/reference/glossary/?all=true#term-control-plane) component which embeds cloud-specific control logic. It lets you link your cluster into your cloud provider's API, and separates out the components that interact with that cloud platform from components that just interact with your cluster. | ||
|
||
By decoupling the interoperability logic between Kubernetes and the underlying cloud infrastructure, the `cloud-controller-manager` component enables cloud providers to release features at a different pace compared to the main Kubernetes project. | ||
|
||
## What is the difference between in-tree and out-of-tree cloud provider? | ||
|
||
In-tree cloud providers are the providers we develop & release in the [main Kubernetes repository](https://github.com/kubernetes/kubernetes/tree/master/pkg/cloudprovider/providers). This results in embedding the knowledge and context of each cloud provider into most of the Kubernetes components. This enables more native integrations such as the kubelet requesting information about itself via a metadata service from the cloud provider. | ||
|
||
Out-of-tree cloud providers are providers that can be developed, built, and released independent of Kubernetes core. This requires deploying a new component called the cloud-controller-manager which is responsible for running all the cloud specific controllers that were previously run in the kube-controller-manager. | ||
|
||
## Which one is recommended? | ||
|
||
We recommend using the in-tree cloud provider at this time because it's out-of-tree counterpart is not 100% ready. However, out-of-tree cloud provider will become the No.1 pick in the near future. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
title: "Known Issues" | ||
linkTitle: "Known Issues" | ||
weight: 2 | ||
type: docs | ||
description: > | ||
Known Issues of Azure cloud provider. | ||
--- |
Oops, something went wrong.