Merge pull request #3758 from aledbf/check-links

Automatic merge from submit-queue.

Add makefile target to check markdown links

fixes #771

Running `make check-markdown-links` we get (just the summary)

```console
Summary
                                                          CONTRIBUTING.md: ✓
                                          addons/route53-mapper/README.md: ✓
                                                         addons/README.md: ✓
                                    addons/kubernetes-dashboard/README.md: ✓
                                           addons/ingress-nginx/README.md: Issues
                                      addons/cluster-autoscaler/README.md: ✓
                                   addons/monitoring-standalone/README.md: ✓
                                                                README.md: ✓
                                                 dns-controller/README.md: ✓
                                             dns-controller/docs/flags.md: ✓
                                                       examples/README.md: ✓
                                                      protokube/README.md: ✓
                                                .github/ISSUE_TEMPLATE.md: ✓
                                                         docker/README.md: ✓
                                                               ROADMAP.md: ✓
                                                     permalinks/README.md: ✓
                                               permalinks/upgrade_kops.md: ✓
                                                permalinks/upgrade_k8s.md: ✓
                                        pkg/apis/kops/v1alpha2/CHANGES.md: ✓
                                        pkg/apis/kops/v1alpha2/upgrade.md: ✓
                                                          upup/DEVELOP.md: ✓
upup/models/cloudup/resources/addons/external-dns.addons.k8s.io/README.md: ✓
                                             upup/pkg/fi/nodeup/README.md: ✓
                                upup/pkg/fi/cloudup/gcetasks/QUESTIONS.md: ✓
                                docs/manifests_and_customizing_via_api.md: ✓
                                              docs/upgrade_from_k8s_12.md: ✓
                                                       docs/http_proxy.md: ✓
                                                  docs/instance_groups.md: ✓
                                                           docs/README.md: ✓
                                                      docs/etcd_backup.md: ✓
                                                         docs/security.md: ✓
                                                              docs/mfa.md: ✓
                                                    docs/boot-sequence.md: ✓
                                                              docs/aws.md: ✓
                                        docs/cli/kops_describe_secrets.md: ✓
                                docs/cli/kops_toolbox_convert-imported.md: ✓
                                  docs/cli/kops_rolling-update_cluster.md: ✓
                                          docs/cli/kops_delete_cluster.md: ✓
                                    docs/cli/kops_delete_instancegroup.md: ✓
                                                 docs/cli/kops_replace.md: ✓
                              docs/cli/kops_create_secret_dockerconfig.md: ✓
                                                  docs/cli/kops_create.md: ✓
                                                  docs/cli/kops_update.md: ✓
                                         docs/cli/kops_edit_federation.md: ✓
                                                 docs/cli/kops_version.md: ✓
                                           docs/cli/kops_delete_secret.md: ✓
                                          docs/cli/kops_update_cluster.md: ✓
                                                  docs/cli/kops_delete.md: ✓
                                              docs/cli/kops_completion.md: ✓
                                    docs/cli/kops_create_instancegroup.md: ✓
                                          docs/cli/kops_rolling-update.md: ✓
                                                 docs/cli/kops_upgrade.md: ✓
                                                docs/cli/kops_describe.md: ✓
                                                docs/cli/kops_validate.md: ✓
                                                 docs/cli/kops_toolbox.md: ✓
                                        docs/cli/kops_toolbox_template.md: ✓
                                        docs/cli/kops_validate_cluster.md: ✓
                                         docs/cli/kops_get_federations.md: ✓
                                                         docs/cli/kops.md: ✓
                                          docs/cli/kops_export_kubecfg.md: ✓
                                          docs/cli/kops_create_cluster.md: ✓
                                      docs/cli/kops_edit_instancegroup.md: ✓
                                            docs/cli/kops_toolbox_dump.md: ✓
                                      docs/cli/kops_get_instancegroups.md: ✓
                                             docs/cli/kops_get_secrets.md: ✓
                                                     docs/cli/kops_get.md: ✓
                                            docs/cli/kops_edit_cluster.md: ✓
                          docs/cli/kops_create_secret_encryptionconfig.md: ✓
                              docs/cli/kops_create_secret_sshpublickey.md: ✓
                                                  docs/cli/kops_import.md: ✓
                                                  docs/cli/kops_export.md: ✓
                                           docs/cli/kops_create_secret.md: ✓
                                            docs/cli/kops_get_clusters.md: ✓
                                         docs/cli/kops_upgrade_cluster.md: ✓
                                          docs/cli/kops_import_cluster.md: ✓
                                                    docs/cli/kops_edit.md: ✓
                                       docs/cli/kops_update_federation.md: ✓
                                                      docs/update_kops.md: ✓
                                                        docs/iam_roles.md: ✓
                                                     docs/cluster_spec.md: Issues
                                                           docs/images.md: ✓
                                              docs/upgrade_from_kubeup.md: ✓
                                                       docs/networking.md: ✓
                                                         docs/commands.md: ✓
                                                   docs/rotate-secrets.md: ✓
                                                        docs/aws-china.md: Issues
                                                  docs/examples/README.md: ✓
                     docs/examples/kops-tests-private-net-bastion-host.md: Issues
                           docs/examples/coreos-kops-tests-multimaster.md: Issues
                             docs/examples/kops-test-route53-subdomain.md: ✓
                                      docs/examples/basic-requirements.md: Issues
                                                               docs/ns.md: ✓
                                                  docs/download_config.md: ✓
                                                       docs/philosophy.md: ✓
                                                          docs/upgrade.md: ✓
                                       docs/vsphere-development-status.md: Issues
                                                           docs/labels.md: ✓
                                                           docs/addons.md: Issues
                                        docs/development/documentation.md: ✓
                                         docs/development/dependencies.md: ✓
                                             docs/development/building.md: ✓
                                               docs/development/gossip.md: ✓
                                          docs/development/api_updates.md: Issues
                                             docs/development/homebrew.md: ✓
                                     docs/development/adding_a_feature.md: ✓
                                               docs/development/Docker.md: ✓
                                        docs/development/instancesizes.md: ✓
                                       docs/development/rolling_update.md: ✓
                                              docs/development/testing.md: Issues
                                                 docs/development/hack.md: ✓
                                         docs/development/how_it_works.md: ✓
                                                docs/development/bazel.md: ✓
                                              docs/development/release.md: ✓
                                                          docs/bastion.md: ✓
                                                     docs/experimental.md: ✓
                                           docs/node_resource_handling.md: ✓
                                                          docs/kubectl.md: ✓
                                                          docs/install.md: Issues
                                           docs/single-to-multi-master.md: Issues
                                                 docs/cluster_template.md: ✓
                                              docs/run_in_existing_vpc.md: ✓
                                                docs/api-server/README.md: ✓
                                                            docs/state.md: ✓
                                                         docs/topology.md: ✓
                                                   docs/releases/1.7.1.md: ✓
                                           docs/releases/1.6.0-alpha.1.md: ✓
                                               docs/releases/1.8-NOTES.md: ✓
                                          docs/releases/legacy-changes.md: ✓
                                               docs/releases/1.7-NOTES.md: ✓
                                                   docs/releases/1.6.2.md: ✓
                                               docs/releases/1.6-NOTES.md: ✓
                                                   docs/releases/1.6.1.md: ✓
                                               docs/creating_subdomain.md: ✓
                                           docs/etcd_volume_encryption.md: ✓
                                                      docs/vsphere-dev.md: Issues
                                  docs/cluster_upgrades_and_migrations.md: Issues
               docs/upgrade_from_kops_1.6_to_1.7_calico_cidr_migration.md: ✓
                                                    docs/addon_manager.md: Issues
                                        docs/advisories/cve_2017_14491.md: ✓
               docs/work_in_progress/pushing_updates_without_rebooting.md: ✓
                                                        docs/arguments.md: ✓
                                                docs/high_availability.md: ✓
                                                         docs/releases.md: ✓
                                              docs/apireference/README.md: ✓
                                        docs/apireference/build/README.md: ✓
                       docs/apireference/build/node_modules/ejs/README.md: ✓
              docs/apireference/build/node_modules/highlight.js/README.md: ✓
                    docs/apireference/build/node_modules/jquery/README.md: ✓
              docs/apireference/build/node_modules/font-awesome/README.md: Issues
                    docs/apireference/build/node_modules/colors/ReadMe.md: ✓
                    docs/apireference/build/node_modules/marked/README.md: ✓
                docs/apireference/build/node_modules/marked/doc/broken.md: ✓
                  docs/apireference/build/node_modules/marked/doc/todo.md: ✓
           docs/apireference/build/node_modules/jquery.scrollto/README.md: ✓
        docs/apireference/build/node_modules/jquery.scrollto/CHANGELOG.md: ✓
                 docs/apireference/build/node_modules/bootstrap/README.md: Issues
              docs/apireference/build/node_modules/bootstrap/CHANGELOG.md: ✓
                      docs/apireference/build/node_modules/mime/README.md: ✓
               docs/apireference/build/node_modules/node-static/README.md: Issues
                        docs/apireference/static_includes/_oldversions.md: ✓
                           docs/apireference/static_includes/_overview.md: ✓
                               docs/apireference/static_includes/_kops.md: ✓
                        docs/apireference/static_includes/_definitions.md: ✓
                                           docs/changing_configuration.md: ✓
                                                              docs/gpu.md: ✓
                                                          docs/secrets.md: ✓
                                                        docs/terraform.md: ✓
                             docs/tutorial/working-with-instancegroups.md: ✓
                                                     docs/tutorial/gce.md: ✓
                                    docs/tutorial/upgrading-kubernetes.md: ✓
                                         hooks/nvidia-bootstrap/README.md: ✓
                                           hooks/prepull-images/README.md: ✓
                                                       code-of-conduct.md: ✓
                                           images/utils-builder/README.md: ✓
                                                             CHANGELOG.md: ✓
Makefile:600: recipe for target 'check-markdown-links' failed
```
This commit is contained in:
Kubernetes Submit Queue 2017-11-03 23:30:54 -07:00 committed by GitHub
commit 49cc8fed5c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 14 additions and 2 deletions

3
.gitignore vendored
View File

@ -70,3 +70,6 @@ bazel-out
bazel-testlogs
# Ignore default apiserver config
apiserver.local.config
# Ignore awesome_bot markdown links check output
ab-results-*.json

View File

@ -594,3 +594,12 @@ bazel-push-gce-run: bazel-push
.PHONY: bazel-push-aws-run
bazel-push-aws-run: bazel-push
ssh -t ${TARGET} sudo SKIP_PACKAGE_UPDATE=1 /tmp/nodeup --conf=/var/cache/kubernetes-install/kube_env.yaml --v=8
.PHONY: check-markdown-links
check-markdown-links:
docker run -t -v $$PWD:/tmp \
-e LC_ALL=C.UTF-8 \
-e LANG=en_US.UTF-8 \
-e LANGUAGE=en_US.UTF-8 \
rubygem/awesome_bot --allow-dupe --allow-redirect \
$(shell find $$PWD -name "*.md" -mindepth 1 -printf '%P\n' | grep -v vendor | grep -v _vendor | grep -v Changelog.md)

View File

@ -204,7 +204,7 @@ Limitations:
4. Verify the planned changes with `kops update cluster cluster.example.com`
5. Create the cluster with `kops update cluster cluster.example.com --yes`
6. Wait around for the cluster to fully come up and be available. `k get nodes` should return `(master + minions) = 15` available nodes.
7. (Optional) Create the Dashboard with `kubectl create -f https://rawgit.com/kubernetes/dashboard/master/src/deploy/kubernetes-dashboard.yaml`
7. (Optional) Create the Dashboard with `kubectl create -f https://raw.githubusercontent.com/kubernetes/dashboard/master/src/deploy/recommended/kubernetes-dashboard.yaml`
8. Deploy the existing resource configuration to the new cluster.
9. Confirm that pods on the new cluster are able to access remote resources.
- For AWS-hosted services, add the generated `nodes.cluster.example.com` security group to the resources that may need it (i.e. ElastiCache, RDS, etc).

View File

@ -3,7 +3,7 @@
Kops uses the Kubernetes API machinery. It is well designed, and very powerful, but you have to
jump through some hoops to use it.
Recommended reading: [kubernetes API changes doc](https://github.com/kubernetes/kubernetes/blob/master/docs/devel/api_changes.md)
Recommended reading: [kubernetes API changes doc](https://github.com/kubernetes/community/blob/master/contributors/devel/api_changes.md)
The kops APIs live in [pkg/apis/kops](https://github.com/kubernetes/kops/tree/master/pkg/apis/kops), both in
that directory directly (the unversioned API) and in the versioned subdirectories (`v1alpha1`, `v1alpha2`).