Skip to content

Commit

Permalink
Fix broken links in docs (#61)
Browse files Browse the repository at this point in the history
  • Loading branch information
Akasurde authored Apr 16, 2021
1 parent 8182a3a commit 28223db
Show file tree
Hide file tree
Showing 17 changed files with 100 additions and 105 deletions.
41 changes: 18 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,40 +24,35 @@ Click on the name of a plugin or module to view that content's documentation:
### Connection plugins
Name | Description
--- | ---
[kubernetes.core.kubectl](https://github.com/ansible-collections/community.kubernetes/blob/main/docs/kubernetes.core.kubectl_connection.rst)|Execute tasks in pods running on Kubernetes.
[kubernetes.core.kubectl](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.kubectl_connection.rst)|Execute tasks in pods running on Kubernetes.

### Filter plugins
### Inventory plugins
Name | Description
--- | ---
kubernetes.core.k8s_config_resource_name|kubernetes.core k8s_config_resource_name filter plugin
[kubernetes.core.k8s](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_inventory.rst)|Kubernetes (K8s) inventory source

### Lookup plugins
Name | Description
--- | ---
[kubernetes.core.k8s](https://github.com/ansible-collections/community.kubernetes/blob/main/docs/kubernetes.core.k8s_lookup.rst)|Query the K8s API
[kubernetes.core.k8s](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_lookup.rst)|Query the K8s API

### Modules
Name | Description
--- | ---
[kubernetes.core.helm](https://github.com/ansible-collections/community.kubernetes/blob/main/docs/kubernetes.core.helm_module.rst)|Manages Kubernetes packages with the Helm package manager
[kubernetes.core.helm_info](https://github.com/ansible-collections/community.kubernetes/blob/main/docs/kubernetes.core.helm_info_module.rst)|Get information from Helm package deployed inside the cluster
[kubernetes.core.helm_plugin](https://github.com/ansible-collections/community.kubernetes/blob/main/docs/kubernetes.core.helm_plugin_module.rst)|Manage Helm plugins
[kubernetes.core.helm_plugin_info](https://github.com/ansible-collections/community.kubernetes/blob/main/docs/kubernetes.core.helm_plugin_info_module.rst)|Gather information about Helm plugins
[kubernetes.core.helm_repository](https://github.com/ansible-collections/community.kubernetes/blob/main/docs/kubernetes.core.helm_repository_module.rst)|Manage Helm repositories.
[kubernetes.core.helm_template](https://github.com/ansible-collections/community.kubernetes/blob/main/docs/kubernetes.core.helm_template_module.rst)|Render chart templates
[kubernetes.core.k8s](https://github.com/ansible-collections/community.kubernetes/blob/main/docs/kubernetes.core.k8s_module.rst)|Manage Kubernetes (K8s) objects
[kubernetes.core.k8s_cluster_info](https://github.com/ansible-collections/community.kubernetes/blob/main/docs/kubernetes.core.k8s_cluster_info_module.rst)|Describe Kubernetes (K8s) cluster, APIs available and their respective versions
[kubernetes.core.k8s_exec](https://github.com/ansible-collections/community.kubernetes/blob/main/docs/kubernetes.core.k8s_exec_module.rst)|Execute command in Pod
[kubernetes.core.k8s_info](https://github.com/ansible-collections/community.kubernetes/blob/main/docs/kubernetes.core.k8s_info_module.rst)|Describe Kubernetes (K8s) objects
[kubernetes.core.k8s_log](https://github.com/ansible-collections/community.kubernetes/blob/main/docs/kubernetes.core.k8s_log_module.rst)|Fetch logs from Kubernetes resources
[kubernetes.core.k8s_rollback](https://github.com/ansible-collections/community.kubernetes/blob/main/docs/kubernetes.core.k8s_rollback_module.rst)|Rollback Kubernetes (K8S) Deployments and DaemonSets
[kubernetes.core.k8s_scale](https://github.com/ansible-collections/community.kubernetes/blob/main/docs/kubernetes.core.k8s_scale_module.rst)|Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job.
[kubernetes.core.k8s_service](https://github.com/ansible-collections/community.kubernetes/blob/main/docs/kubernetes.core.k8s_service_module.rst)|Manage Services on Kubernetes

### Inventory plugins
Name | Description
--- | ---
[kubernetes.core.k8s](https://github.com/ansible-collections/community.kubernetes/blob/main/docs/kubernetes.core.k8s_inventory.rst)|Kubernetes (K8s) inventory source
[kubernetes.core.helm](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.helm_module.rst)|Manages Kubernetes packages with the Helm package manager
[kubernetes.core.helm_info](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.helm_info_module.rst)|Get information from Helm package deployed inside the cluster
[kubernetes.core.helm_plugin](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.helm_plugin_module.rst)|Manage Helm plugins
[kubernetes.core.helm_plugin_info](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.helm_plugin_info_module.rst)|Gather information about Helm plugins
[kubernetes.core.helm_repository](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.helm_repository_module.rst)|Manage Helm repositories.
[kubernetes.core.helm_template](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.helm_template_module.rst)|Render chart templates
[kubernetes.core.k8s](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_module.rst)|Manage Kubernetes (K8s) objects
[kubernetes.core.k8s_cluster_info](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_cluster_info_module.rst)|Describe Kubernetes (K8s) cluster, APIs available and their respective versions
[kubernetes.core.k8s_exec](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_exec_module.rst)|Execute command in Pod
[kubernetes.core.k8s_info](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_info_module.rst)|Describe Kubernetes (K8s) objects
[kubernetes.core.k8s_log](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_log_module.rst)|Fetch logs from Kubernetes resources
[kubernetes.core.k8s_rollback](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_rollback_module.rst)|Rollback Kubernetes (K8S) Deployments and DaemonSets
[kubernetes.core.k8s_scale](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_scale_module.rst)|Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job.
[kubernetes.core.k8s_service](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_service_module.rst)|Manage Services on Kubernetes

<!--end collection content-->

Expand Down
4 changes: 2 additions & 2 deletions docs/kubernetes.core.helm_info_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -202,10 +202,10 @@ Parameters
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
- name: Deploy latest version of Grafana chart inside monitoring namespace
community.kubernetes.helm_info:
kubernetes.core.helm_info:
name: test
release_namespace: monitoring
Expand Down
18 changes: 9 additions & 9 deletions docs/kubernetes.core.helm_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -499,46 +499,46 @@ Parameters
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
- name: Deploy latest version of Prometheus chart inside monitoring namespace (and create it)
community.kubernetes.helm:
kubernetes.core.helm:
name: test
chart_ref: stable/prometheus
release_namespace: monitoring
create_namespace: true
# From repository
- name: Add stable chart repo
community.kubernetes.helm_repository:
kubernetes.core.helm_repository:
name: stable
repo_url: "https://kubernetes.github.io/ingress-nginx"
- name: Deploy latest version of Grafana chart inside monitoring namespace with values
community.kubernetes.helm:
kubernetes.core.helm:
name: test
chart_ref: stable/grafana
release_namespace: monitoring
values:
replicas: 2
- name: Deploy Grafana chart on 5.0.12 with values loaded from template
community.kubernetes.helm:
kubernetes.core.helm:
name: test
chart_ref: stable/grafana
chart_version: 5.0.12
values: "{{ lookup('template', 'somefile.yaml') | from_yaml }}"
- name: Deploy Grafana chart using values files on target
community.kubernetes.helm:
kubernetes.core.helm:
name: test
chart_ref: stable/grafana
release_namespace: monitoring
values_files:
- /path/to/values.yaml
- name: Remove test release and waiting suppression ending
community.kubernetes.helm:
kubernetes.core.helm:
name: test
state: absent
wait: true
Expand All @@ -550,14 +550,14 @@ Examples
dest: /tmp/helm_repo
- name: Deploy Grafana chart from local path
community.kubernetes.helm:
kubernetes.core.helm:
name: test
chart_ref: /tmp/helm_repo/stable/grafana
release_namespace: monitoring
# From url
- name: Deploy Grafana chart on 5.6.0 from url
community.kubernetes.helm:
kubernetes.core.helm:
name: test
chart_ref: "https://github.com/grafana/helm-charts/releases/download/grafana-5.6.0/grafana-5.6.0.tgz"
release_namespace: monitoring
Expand Down
6 changes: 3 additions & 3 deletions docs/kubernetes.core.helm_plugin_info_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -198,13 +198,13 @@ Parameters
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
- name: Gather Helm plugin info
community.kubernetes.helm_plugin_info:
kubernetes.core.helm_plugin_info:
- name: Gather Helm env plugin info
community.kubernetes.helm_plugin_info:
kubernetes.core.helm_plugin_info:
plugin_name: env
Expand Down
8 changes: 4 additions & 4 deletions docs/kubernetes.core.helm_plugin_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -236,20 +236,20 @@ Parameters
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
- name: Install Helm env plugin
community.kubernetes.helm_plugin:
kubernetes.core.helm_plugin:
plugin_path: https://github.com/adamreese/helm-env
state: present
- name: Install Helm plugin from local filesystem
community.kubernetes.helm_plugin:
kubernetes.core.helm_plugin:
plugin_path: https://domain/path/to/plugin.tar.gz
state: present
- name: Remove Helm env plugin
community.kubernetes.helm_plugin:
kubernetes.core.helm_plugin:
plugin_name: env
state: absent
Expand Down
6 changes: 3 additions & 3 deletions docs/kubernetes.core.helm_repository_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -151,15 +151,15 @@ Parameters
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
- name: Add a repository
community.kubernetes.helm_repository:
kubernetes.core.helm_repository:
name: stable
repo_url: https://kubernetes.github.io/ingress-nginx
- name: Add Red Hat Helm charts repository
community.kubernetes.helm_repository:
kubernetes.core.helm_repository:
name: redhat-charts
repo_url: https://redhat-developer.github.com/redhat-helm-charts
Expand Down
6 changes: 3 additions & 3 deletions docs/kubernetes.core.helm_template_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -196,15 +196,15 @@ Parameters
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
- name: Render templates to specified directory
community.kubernetes.helm_template:
kubernetes.core.helm_template:
chart_ref: stable/prometheus
output_dir: mycharts
- name: Render templates
community.kubernetes.helm_template:
kubernetes.core.helm_template:
chart_ref: stable/prometheus
register: result
Expand Down
6 changes: 3 additions & 3 deletions docs/kubernetes.core.k8s_cluster_info_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -277,14 +277,14 @@ Notes
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
- name: Get Cluster information
community.kubernetes.k8s_cluster_info:
kubernetes.core.k8s_cluster_info:
register: api_status
- name: Do not invalidate cache before getting information
community.kubernetes.k8s_cluster_info:
kubernetes.core.k8s_cluster_info:
invalidate_cache: False
register: api_status
Expand Down
6 changes: 3 additions & 3 deletions docs/kubernetes.core.k8s_exec_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -323,16 +323,16 @@ Notes
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
- name: Execute a command
community.kubernetes.k8s_exec:
kubernetes.core.k8s_exec:
namespace: myproject
pod: zuul-scheduler
command: zuul-scheduler full-reconfigure
- name: Check RC status of command executed
community.kubernetes.k8s_exec:
kubernetes.core.k8s_exec:
namespace: myproject
pod: busybox-test
command: cmd_with_non_zero_exit_code
Expand Down
18 changes: 9 additions & 9 deletions docs/kubernetes.core.k8s_info_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -500,56 +500,56 @@ Notes
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
- name: Get an existing Service object
community.kubernetes.k8s_info:
kubernetes.core.k8s_info:
api_version: v1
kind: Service
name: web
namespace: testing
register: web_service
- name: Get a list of all service objects
community.kubernetes.k8s_info:
kubernetes.core.k8s_info:
api_version: v1
kind: Service
namespace: testing
register: service_list
- name: Get a list of all pods from any namespace
community.kubernetes.k8s_info:
kubernetes.core.k8s_info:
kind: Pod
register: pod_list
- name: Search for all Pods labelled app=web
community.kubernetes.k8s_info:
kubernetes.core.k8s_info:
kind: Pod
label_selectors:
- app = web
- tier in (dev, test)
- name: Using vars while using label_selectors
community.kubernetes.k8s_info:
kubernetes.core.k8s_info:
kind: Pod
label_selectors:
- "app = {{ app_label_web }}"
vars:
app_label_web: web
- name: Search for all running pods
community.kubernetes.k8s_info:
kubernetes.core.k8s_info:
kind: Pod
field_selectors:
- status.phase=Running
- name: List custom objects created using CRD
community.kubernetes.k8s_info:
kubernetes.core.k8s_info:
kind: MyCustomObject
api_version: "stable.example.com/v1"
- name: Wait till the Object is created
community.kubernetes.k8s_info:
kubernetes.core.k8s_info:
kind: Pod
wait: yes
name: pod-not-yet-created
Expand Down
10 changes: 5 additions & 5 deletions docs/kubernetes.core.k8s_inventory.rst
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ Parameters
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>community.kubernetes.k8s</li>
<li>kubernetes.core.k8s</li>
<li>k8s</li>
</ul>
</td>
Expand All @@ -317,25 +317,25 @@ Parameters
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
# File must be named k8s.yaml or k8s.yml
# Authenticate with token, and return all pods and services for all namespaces
plugin: community.kubernetes.k8s
plugin: kubernetes.core.k8s
connections:
- host: https://192.168.64.4:8443
api_key: xxxxxxxxxxxxxxxx
validate_certs: false
# Use default config (~/.kube/config) file and active context, and return objects for a specific namespace
plugin: community.kubernetes.k8s
plugin: kubernetes.core.k8s
connections:
- namespaces:
- testing
# Use a custom config file, and a specific context.
plugin: community.kubernetes.k8s
plugin: kubernetes.core.k8s
connections:
- kubeconfig: /path/to/config
context: 'awx/192-168-64-4:8443/developer'
Expand Down
Loading

0 comments on commit 28223db

Please sign in to comment.