Skip to content

Commit 28223db

Browse files
authored
Fix broken links in docs (#61)
1 parent 8182a3a commit 28223db

17 files changed

+100
-105
lines changed

README.md

+18-23
Original file line numberDiff line numberDiff line change
@@ -24,40 +24,35 @@ Click on the name of a plugin or module to view that content's documentation:
2424
### Connection plugins
2525
Name | Description
2626
--- | ---
27-
[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.
27+
[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.
2828

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

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

3939
### Modules
4040
Name | Description
4141
--- | ---
42-
[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
43-
[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
44-
[kubernetes.core.helm_plugin](https://github.com/ansible-collections/community.kubernetes/blob/main/docs/kubernetes.core.helm_plugin_module.rst)|Manage Helm plugins
45-
[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
46-
[kubernetes.core.helm_repository](https://github.com/ansible-collections/community.kubernetes/blob/main/docs/kubernetes.core.helm_repository_module.rst)|Manage Helm repositories.
47-
[kubernetes.core.helm_template](https://github.com/ansible-collections/community.kubernetes/blob/main/docs/kubernetes.core.helm_template_module.rst)|Render chart templates
48-
[kubernetes.core.k8s](https://github.com/ansible-collections/community.kubernetes/blob/main/docs/kubernetes.core.k8s_module.rst)|Manage Kubernetes (K8s) objects
49-
[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
50-
[kubernetes.core.k8s_exec](https://github.com/ansible-collections/community.kubernetes/blob/main/docs/kubernetes.core.k8s_exec_module.rst)|Execute command in Pod
51-
[kubernetes.core.k8s_info](https://github.com/ansible-collections/community.kubernetes/blob/main/docs/kubernetes.core.k8s_info_module.rst)|Describe Kubernetes (K8s) objects
52-
[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
53-
[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
54-
[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.
55-
[kubernetes.core.k8s_service](https://github.com/ansible-collections/community.kubernetes/blob/main/docs/kubernetes.core.k8s_service_module.rst)|Manage Services on Kubernetes
56-
57-
### Inventory plugins
58-
Name | Description
59-
--- | ---
60-
[kubernetes.core.k8s](https://github.com/ansible-collections/community.kubernetes/blob/main/docs/kubernetes.core.k8s_inventory.rst)|Kubernetes (K8s) inventory source
42+
[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
43+
[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
44+
[kubernetes.core.helm_plugin](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.helm_plugin_module.rst)|Manage Helm plugins
45+
[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
46+
[kubernetes.core.helm_repository](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.helm_repository_module.rst)|Manage Helm repositories.
47+
[kubernetes.core.helm_template](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.helm_template_module.rst)|Render chart templates
48+
[kubernetes.core.k8s](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_module.rst)|Manage Kubernetes (K8s) objects
49+
[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
50+
[kubernetes.core.k8s_exec](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_exec_module.rst)|Execute command in Pod
51+
[kubernetes.core.k8s_info](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_info_module.rst)|Describe Kubernetes (K8s) objects
52+
[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
53+
[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
54+
[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.
55+
[kubernetes.core.k8s_service](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_service_module.rst)|Manage Services on Kubernetes
6156

6257
<!--end collection content-->
6358

docs/kubernetes.core.helm_info_module.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -202,10 +202,10 @@ Parameters
202202
Examples
203203
--------
204204

205-
.. code-block:: yaml+jinja
205+
.. code-block:: yaml
206206
207207
- name: Deploy latest version of Grafana chart inside monitoring namespace
208-
community.kubernetes.helm_info:
208+
kubernetes.core.helm_info:
209209
name: test
210210
release_namespace: monitoring
211211

docs/kubernetes.core.helm_module.rst

+9-9
Original file line numberDiff line numberDiff line change
@@ -499,46 +499,46 @@ Parameters
499499
Examples
500500
--------
501501

502-
.. code-block:: yaml+jinja
502+
.. code-block:: yaml
503503
504504
- name: Deploy latest version of Prometheus chart inside monitoring namespace (and create it)
505-
community.kubernetes.helm:
505+
kubernetes.core.helm:
506506
name: test
507507
chart_ref: stable/prometheus
508508
release_namespace: monitoring
509509
create_namespace: true
510510
511511
# From repository
512512
- name: Add stable chart repo
513-
community.kubernetes.helm_repository:
513+
kubernetes.core.helm_repository:
514514
name: stable
515515
repo_url: "https://kubernetes.github.io/ingress-nginx"
516516
517517
- name: Deploy latest version of Grafana chart inside monitoring namespace with values
518-
community.kubernetes.helm:
518+
kubernetes.core.helm:
519519
name: test
520520
chart_ref: stable/grafana
521521
release_namespace: monitoring
522522
values:
523523
replicas: 2
524524
525525
- name: Deploy Grafana chart on 5.0.12 with values loaded from template
526-
community.kubernetes.helm:
526+
kubernetes.core.helm:
527527
name: test
528528
chart_ref: stable/grafana
529529
chart_version: 5.0.12
530530
values: "{{ lookup('template', 'somefile.yaml') | from_yaml }}"
531531
532532
- name: Deploy Grafana chart using values files on target
533-
community.kubernetes.helm:
533+
kubernetes.core.helm:
534534
name: test
535535
chart_ref: stable/grafana
536536
release_namespace: monitoring
537537
values_files:
538538
- /path/to/values.yaml
539539
540540
- name: Remove test release and waiting suppression ending
541-
community.kubernetes.helm:
541+
kubernetes.core.helm:
542542
name: test
543543
state: absent
544544
wait: true
@@ -550,14 +550,14 @@ Examples
550550
dest: /tmp/helm_repo
551551
552552
- name: Deploy Grafana chart from local path
553-
community.kubernetes.helm:
553+
kubernetes.core.helm:
554554
name: test
555555
chart_ref: /tmp/helm_repo/stable/grafana
556556
release_namespace: monitoring
557557
558558
# From url
559559
- name: Deploy Grafana chart on 5.6.0 from url
560-
community.kubernetes.helm:
560+
kubernetes.core.helm:
561561
name: test
562562
chart_ref: "https://github.com/grafana/helm-charts/releases/download/grafana-5.6.0/grafana-5.6.0.tgz"
563563
release_namespace: monitoring

docs/kubernetes.core.helm_plugin_info_module.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -198,13 +198,13 @@ Parameters
198198
Examples
199199
--------
200200

201-
.. code-block:: yaml+jinja
201+
.. code-block:: yaml
202202
203203
- name: Gather Helm plugin info
204-
community.kubernetes.helm_plugin_info:
204+
kubernetes.core.helm_plugin_info:
205205
206206
- name: Gather Helm env plugin info
207-
community.kubernetes.helm_plugin_info:
207+
kubernetes.core.helm_plugin_info:
208208
plugin_name: env
209209
210210

docs/kubernetes.core.helm_plugin_module.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -236,20 +236,20 @@ Parameters
236236
Examples
237237
--------
238238

239-
.. code-block:: yaml+jinja
239+
.. code-block:: yaml
240240
241241
- name: Install Helm env plugin
242-
community.kubernetes.helm_plugin:
242+
kubernetes.core.helm_plugin:
243243
plugin_path: https://github.com/adamreese/helm-env
244244
state: present
245245
246246
- name: Install Helm plugin from local filesystem
247-
community.kubernetes.helm_plugin:
247+
kubernetes.core.helm_plugin:
248248
plugin_path: https://domain/path/to/plugin.tar.gz
249249
state: present
250250
251251
- name: Remove Helm env plugin
252-
community.kubernetes.helm_plugin:
252+
kubernetes.core.helm_plugin:
253253
plugin_name: env
254254
state: absent
255255

docs/kubernetes.core.helm_repository_module.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -151,15 +151,15 @@ Parameters
151151
Examples
152152
--------
153153

154-
.. code-block:: yaml+jinja
154+
.. code-block:: yaml
155155
156156
- name: Add a repository
157-
community.kubernetes.helm_repository:
157+
kubernetes.core.helm_repository:
158158
name: stable
159159
repo_url: https://kubernetes.github.io/ingress-nginx
160160
161161
- name: Add Red Hat Helm charts repository
162-
community.kubernetes.helm_repository:
162+
kubernetes.core.helm_repository:
163163
name: redhat-charts
164164
repo_url: https://redhat-developer.github.com/redhat-helm-charts
165165

docs/kubernetes.core.helm_template_module.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -196,15 +196,15 @@ Parameters
196196
Examples
197197
--------
198198

199-
.. code-block:: yaml+jinja
199+
.. code-block:: yaml
200200
201201
- name: Render templates to specified directory
202-
community.kubernetes.helm_template:
202+
kubernetes.core.helm_template:
203203
chart_ref: stable/prometheus
204204
output_dir: mycharts
205205
206206
- name: Render templates
207-
community.kubernetes.helm_template:
207+
kubernetes.core.helm_template:
208208
chart_ref: stable/prometheus
209209
register: result
210210

docs/kubernetes.core.k8s_cluster_info_module.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -277,14 +277,14 @@ Notes
277277
Examples
278278
--------
279279

280-
.. code-block:: yaml+jinja
280+
.. code-block:: yaml
281281
282282
- name: Get Cluster information
283-
community.kubernetes.k8s_cluster_info:
283+
kubernetes.core.k8s_cluster_info:
284284
register: api_status
285285
286286
- name: Do not invalidate cache before getting information
287-
community.kubernetes.k8s_cluster_info:
287+
kubernetes.core.k8s_cluster_info:
288288
invalidate_cache: False
289289
register: api_status
290290

docs/kubernetes.core.k8s_exec_module.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -323,16 +323,16 @@ Notes
323323
Examples
324324
--------
325325

326-
.. code-block:: yaml+jinja
326+
.. code-block:: yaml
327327
328328
- name: Execute a command
329-
community.kubernetes.k8s_exec:
329+
kubernetes.core.k8s_exec:
330330
namespace: myproject
331331
pod: zuul-scheduler
332332
command: zuul-scheduler full-reconfigure
333333
334334
- name: Check RC status of command executed
335-
community.kubernetes.k8s_exec:
335+
kubernetes.core.k8s_exec:
336336
namespace: myproject
337337
pod: busybox-test
338338
command: cmd_with_non_zero_exit_code

docs/kubernetes.core.k8s_info_module.rst

+9-9
Original file line numberDiff line numberDiff line change
@@ -500,56 +500,56 @@ Notes
500500
Examples
501501
--------
502502

503-
.. code-block:: yaml+jinja
503+
.. code-block:: yaml
504504
505505
- name: Get an existing Service object
506-
community.kubernetes.k8s_info:
506+
kubernetes.core.k8s_info:
507507
api_version: v1
508508
kind: Service
509509
name: web
510510
namespace: testing
511511
register: web_service
512512
513513
- name: Get a list of all service objects
514-
community.kubernetes.k8s_info:
514+
kubernetes.core.k8s_info:
515515
api_version: v1
516516
kind: Service
517517
namespace: testing
518518
register: service_list
519519
520520
- name: Get a list of all pods from any namespace
521-
community.kubernetes.k8s_info:
521+
kubernetes.core.k8s_info:
522522
kind: Pod
523523
register: pod_list
524524
525525
- name: Search for all Pods labelled app=web
526-
community.kubernetes.k8s_info:
526+
kubernetes.core.k8s_info:
527527
kind: Pod
528528
label_selectors:
529529
- app = web
530530
- tier in (dev, test)
531531
532532
- name: Using vars while using label_selectors
533-
community.kubernetes.k8s_info:
533+
kubernetes.core.k8s_info:
534534
kind: Pod
535535
label_selectors:
536536
- "app = {{ app_label_web }}"
537537
vars:
538538
app_label_web: web
539539
540540
- name: Search for all running pods
541-
community.kubernetes.k8s_info:
541+
kubernetes.core.k8s_info:
542542
kind: Pod
543543
field_selectors:
544544
- status.phase=Running
545545
546546
- name: List custom objects created using CRD
547-
community.kubernetes.k8s_info:
547+
kubernetes.core.k8s_info:
548548
kind: MyCustomObject
549549
api_version: "stable.example.com/v1"
550550
551551
- name: Wait till the Object is created
552-
community.kubernetes.k8s_info:
552+
kubernetes.core.k8s_info:
553553
kind: Pod
554554
wait: yes
555555
name: pod-not-yet-created

docs/kubernetes.core.k8s_inventory.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ Parameters
298298
</td>
299299
<td>
300300
<ul style="margin: 0; padding: 0"><b>Choices:</b>
301-
<li>community.kubernetes.k8s</li>
301+
<li>kubernetes.core.k8s</li>
302302
<li>k8s</li>
303303
</ul>
304304
</td>
@@ -317,25 +317,25 @@ Parameters
317317
Examples
318318
--------
319319

320-
.. code-block:: yaml+jinja
320+
.. code-block:: yaml
321321
322322
# File must be named k8s.yaml or k8s.yml
323323
324324
# Authenticate with token, and return all pods and services for all namespaces
325-
plugin: community.kubernetes.k8s
325+
plugin: kubernetes.core.k8s
326326
connections:
327327
- host: https://192.168.64.4:8443
328328
api_key: xxxxxxxxxxxxxxxx
329329
validate_certs: false
330330
331331
# Use default config (~/.kube/config) file and active context, and return objects for a specific namespace
332-
plugin: community.kubernetes.k8s
332+
plugin: kubernetes.core.k8s
333333
connections:
334334
- namespaces:
335335
- testing
336336
337337
# Use a custom config file, and a specific context.
338-
plugin: community.kubernetes.k8s
338+
plugin: kubernetes.core.k8s
339339
connections:
340340
- kubeconfig: /path/to/config
341341
context: 'awx/192-168-64-4:8443/developer'

0 commit comments

Comments
 (0)