Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hello World #94

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,4 @@ The contents of this repository are open-source licensed. However, it makes refe
For product and [pricing](https://about.sourcegraph.com/pricing/) information, visit
[about.sourcegraph.com](https://about.sourcegraph.com) or [contact
us](https://about.sourcegraph.com/contact/sales) for more information.
Hello World
1 change: 1 addition & 0 deletions base/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@ If using cluster roles and cluster rolebinding RBAC is not feasible, you may cho
## Deploy Sourcegraph

See the [Sourcegraph Kustomize docs](https://docs.sourcegraph.com/admin/deploy/kubernetes/kustomize) for the latested instructions.
Hello World
1 change: 1 addition & 0 deletions base/monitoring/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@ cAdvisor is not included in the monitoring stack by default.
cAdvisor must be run as root in a Kubernetes cluster with role-based access control (RBAC) enabled to collect metrics.

You can add the cadvisor component to your overlay to deploy cAdvisor.
Hello World
1 change: 1 addition & 0 deletions base/monitoring/cadvisor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ Note that the `sourcegraph/cadvisor` Docker images come with a set of default fl

If you are deploying Sourcegraph to a non-default namespace, you'll have to change the namespace specified in
[cadvisor.ClusterRoleBinding.yaml](cadvisor.ClusterRoleBinding.yaml) to the one that you created. You can do this by editing the namespace directly, or by using the [namespaced overlay](../../configure/../overlays/namespaced/README.md).
Hello World
1 change: 1 addition & 0 deletions base/monitoring/grafana/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@

A Grafana instance is part of the default Sourcegraph cluster installation.
Learn more about Grafana in the [metrics and dashboards guide](https://docs.sourcegraph.com/admin/observability/metrics).
Hello World
1 change: 1 addition & 0 deletions base/monitoring/jaeger/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Jaeger

A Jaeger backend, consisting of its [Collector](https://www.jaegertracing.io/docs/1.37/architecture/#collector) and [Query](https://www.jaegertracing.io/docs/1.37/architecture/#query) components.
Hello World
1 change: 1 addition & 0 deletions base/monitoring/prometheus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,3 +114,4 @@ Additional rules and alerts can be defined in `extra_rules.yml` - see [Prometheu
## Metrics

See [metrics and dashboards](https://docs.sourcegraph.com/admin/observability/metrics).
Hello World
1 change: 1 addition & 0 deletions components/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ These components can include files and other resources that are used to enhance
## How to use

See our [Configure Sourcegraph with Kustomize docs](https://docs.sourcegraph.com/admin/deploy/kubernetes/configure) for the latest instructions.
Hello World
1 change: 1 addition & 0 deletions components/clusters/aws/aws-ebs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ This component configures:
- Ingress to use AWS Load Balancer Controller
- Storage Class to use AWS EBS CSI driver with `ebs.csi.aws.com` storageClass provisioner
- Use this provisioner when using the self-managed Amazon EBS Container Storage Interface driver
Hello World
1 change: 1 addition & 0 deletions components/clusters/aws/ebs-csi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ This component configures:
- Ingress to use AWS Load Balancer Controller
- Storage Class to use AWS EBS CSI driver with `kubernetes.io/aws-ebs` storageClass provisioner
- Use this provisioner when using the AWS EBS CSI driver as Amazon EKS add-on
Hello World
1 change: 1 addition & 0 deletions components/clusters/gke/configure/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ This directory includes components to configure:
- a [BackendConfig](https://cloud.google.com/kubernetes-engine/docs/how-to/ingress-configuration#create_backendconfig) CRD. This is necessary to instruct the GCP load balancer on how to perform health checks on our deployment.
- Ingress to use [Container-native load balancing](https://cloud.google.com/kubernetes-engine/docs/how-to/container-native-load-balancing) to expose Sourcegraph publicly on a domain of your choosing and
- Storage Class to use [Compute Engine persistent disk](https://cloud.google.com/kubernetes-engine/docs/how-to/persistent-volumes/gce-pd-csi-driver).
Hello World
2 changes: 1 addition & 1 deletion components/clusters/minikube/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
This component deletes resource declarations and storage classnames to enable runnning Sourcegraph on minikube.
This component deletes resource declarations and storage classnames to enable runnning Sourcegraph on minikube.Hello World
1 change: 1 addition & 0 deletions components/clusters/old-base/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ It updates and generates resources from the old cluster includes:
This should only be used to generate old cluster for comparision purpose.

Check out the `examples/old-cluster` directory to see how this component is used.
Hello World
1 change: 1 addition & 0 deletions components/custom/otel-collector/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
Component to deploy [otel-collector(OpenTelemetry)](https://docs.sourcegraph.com/admin/observability/opentelemetry) with default settings on your instance to enable [tracing](https://docs.sourcegraph.com/admin/observability/opentelemetry#tracing).
Hello World
1 change: 1 addition & 0 deletions components/disable/service-discovery/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
Remove RBACs resources to disable service discovery for frontend.

If `sourcegraph-frontend.RoleBinding` was created previously, you will need to add the `/components/disable/service-discovery/role-binding` component to remove it,
Hello World
1 change: 1 addition & 0 deletions components/enable/otel-collector/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
Component to deploy [otel-collector(OpenTelemetry)](https://docs.sourcegraph.com/admin/observability/opentelemetry) with default settings on your instance to enable [tracing](https://docs.sourcegraph.com/admin/observability/opentelemetry#tracing).
Hello World
1 change: 1 addition & 0 deletions components/enable/private-registry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ Update image names and tags easily using the built-in [images transformer](https
## How to use

Replace the `$(PRIVATE_REGISTRY)` environment variables inside the kustomization.yaml file manually
Hello World
1 change: 1 addition & 0 deletions components/enable/service-discovery-default/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Enable component: service discover

Set service account for frontend to `default` to enable service discovery.
Hello World
1 change: 1 addition & 0 deletions components/enable/service-discovery/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Enable component: service discover

Add RBACs resources to enable service discovery for frontend.
Hello World
1 change: 1 addition & 0 deletions components/executors/dind/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,4 @@ Optionally, a Private Docker Registry can be deployed to avoid Docker Hub rate l
- [Registry Deployment](./private-docker-registry/private-docker-registry.Deployment.yaml) A private docker registry configured as a pull-through cache to avoid docker hub rate limiting.
- [Registry Service](./private-docker-registry/private-docker-registry.Service.yaml) A service to access the private-docker-registry.
- [Registry Persistent Volume](./private-docker-registry/private-docker-registry.PersistentVolumeClaim.yaml) A volume to store images in the private-docker-registry.
Hello World
1 change: 1 addition & 0 deletions components/executors/k8s/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ The following components will deploy:
- [Executor Role](./rbac/executor.Role.yaml) Contains the required rules.
- [Executor Role Binding](./rbac/executor.RoleBinding.yaml) Binds the rules to the executor service account.
- [Executor Service Account](./rbac/executor.ServiceAccount.yaml) The service account used by executors.
Hello World
1 change: 1 addition & 0 deletions components/ingress/alb/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# AWS ALB component

This component configures Ingress to use AWS Load Balancer Controller to expose Sourcegraph publicly on a domain of your choosing
Hello World
1 change: 1 addition & 0 deletions components/ingress/hostname/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# hostname component

Component to add hostname to frontend ingress
Hello World
1 change: 1 addition & 0 deletions components/ingress/nginx-controller/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
[ingress-nginx](https://github.com/kubernetes/ingress-nginx) provide specialized routing for all of the publicly available instances on this cluster.

This component is for configuring the[ v1.5.1 ingress-nginx controller for generic cloud provider](https://github.com/kubernetes/ingress-nginx/tree/controller-v1.5.1/deploy/static/provider/cloud) for Sourcegraph.
Hello World
1 change: 1 addition & 0 deletions components/monitoring/no-rbacs/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
Monitoring stacks with all RBAC resources and the related services removed.
Hello World
1 change: 1 addition & 0 deletions components/monitoring/privileged/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
Update cadvisor to run as root with privileged for service resources usage data.
Hello World
1 change: 1 addition & 0 deletions components/monitoring/rbacs/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
RBAC resources for monitoring services (cadvisor not included)
Hello World
1 change: 1 addition & 0 deletions components/monitoring/tracing/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Tracing

Add otel with a Jaeger backend, consisting of its [Collector](https://www.jaegertracing.io/docs/1.37/architecture/#collector) and [Query](https://www.jaegertracing.io/docs/1.37/architecture/#query) components. It also [configures](https://github.com/sourcegraph/sourcegraph/blob/main/docker-images/opentelemetry-collector/configs/jaeger.yaml) the `otel-collector` to export to this Jaeger instance.
Hello World
1 change: 1 addition & 0 deletions components/network/tls/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
For demostration only. We do not recommend storing any keys or secrets remotely.

DO NOT commit any keys or secrets to public or private repositories.
Hello World
1 change: 1 addition & 0 deletions components/privileged/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
Run as root with privileges
Hello World
1 change: 1 addition & 0 deletions components/remove/daemonset/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ A component to delete all daemonsets and its related resources:
# WARNING

Cannot be used with the [delete-cadvisor component](./delete-cadvisor/README.md), or you will see an error about not being able to find the cadvisor to delete. This is because the daemonset has already been deleted by the delete-cadvisor component.
Hello World
1 change: 1 addition & 0 deletions components/remove/resources/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
Remove all container resources
Hello World
1 change: 1 addition & 0 deletions components/services/searcher/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
Component to deploy searcher as Deployment instead of Statefulset and vice versa
Hello World
1 change: 1 addition & 0 deletions components/services/searcher/deployment/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
A component to deploy searcher as Deployment instead of Statefulset.

It add the searcher Deployment resource and delete the searcher Statefulset.
Hello World
1 change: 1 addition & 0 deletions components/services/symbols/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
Component to deploy symbols as Deployment instead of Statefulset and vice versa
Hello World
1 change: 1 addition & 0 deletions components/services/symbols/deployment/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
A component to deploy symbols as Deployment instead of Statefulset.

It add the symbols Deployment resource and delete the symbols Statefulset.
Hello World
1 change: 1 addition & 0 deletions components/sizes/l/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ A Component to update the resources for your Sourcegraph deployment to support u
- 100,000 repositories

Rockskip is enabled by default. Use the rockskip/disable component to disable rockskip if needed.
Hello World
1 change: 1 addition & 0 deletions components/sizes/m/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ A Component to update the resources for your Sourcegraph deployment to support u
- 50,000 repositories

Rockskip is enabled by default. Use the rockskip/disable component to disable rockskip if needed.
Hello World
1 change: 1 addition & 0 deletions components/sizes/s/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ A Component to update the resources for your Sourcegraph deployment to support u
- 10,000 repositories

Rockskip is enabled by default. Use the rockskip/disable component to disable rockskip if needed.
Hello World
1 change: 1 addition & 0 deletions components/sizes/xl/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ A Component to update the resources for your Sourcegraph deployment to support u
- 250,000 repositories

Rockskip is enabled by default. Use the rockskip/disable component to disable rockskip if needed.
Hello World
1 change: 1 addition & 0 deletions components/sizes/xs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ A Component to update the resources for your Sourcegraph deployment to support u
- 5,000 repositories

Rockskip is enabled by default. Use the rockskip/disable component to disable rockskip if needed.
Hello World
1 change: 1 addition & 0 deletions components/storage-class/aws/aws-ebs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ This component:
- sets the provisioner to `kubernetes.io/aws-ebs`.

Use this provisioner when using the Amazon EKS add-on
Hello World
1 change: 1 addition & 0 deletions components/storage-class/aws/ebs-csi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ This component:
- sets the provisioner to `ebs.csi.aws.com`.

Use this provisioner when using the self-managed Amazon EBS Container Storage Interface driver
Hello World
2 changes: 1 addition & 1 deletion components/storage-class/azure/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# # Storageclass Component for Azure

For more information, please refer to our documentation on [configuring a storage class for your cloud provider](http://localhost:5080/admin/deploy/kubernetes/configure#configure-a-storage-class).
For more information, please refer to our documentation on [configuring a storage class for your cloud provider](http://localhost:5080/admin/deploy/kubernetes/configure#configure-a-storage-class).Hello World
2 changes: 1 addition & 1 deletion components/storage-class/gcp/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# # Storageclass Component for Google Cloud Platform (GCP)

For more information, please refer to our documentation on [configuring a storage class for your cloud provider](http://localhost:5080/admin/deploy/kubernetes/configure#configure-a-storage-class).
For more information, please refer to our documentation on [configuring a storage class for your cloud provider](http://localhost:5080/admin/deploy/kubernetes/configure#configure-a-storage-class).Hello World
1 change: 1 addition & 0 deletions components/storage-class/sourcegraph/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
Component to update storage class name to `sourcegraph`
Hello World
1 change: 1 addition & 0 deletions components/storage-class/ssd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,4 @@ This component should be run periodically to clean up files in the SSD on each n
## How to use

Define the $SSD_NODE_PATH variable in your OVERLAY CONFIGURATIONS.
Hello World
1 change: 1 addition & 0 deletions components/utils/migrate-to-nonprivileged/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
This kustomization injects initContainers in all pods with persistent volumes to transfer ownership of directories to
specified non-root users. It is used for migrating existing installations to a non-root environment.
Hello World
1 change: 1 addition & 0 deletions components/utils/migrator/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
This component create resources for executing database migrations outside of a code deployment.

For more information, please see: https://docs.sourcegraph.com/admin/install/kubernetes/operations#database-migrations
Hello World
1 change: 1 addition & 0 deletions components/utils/multi-version-upgrade/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
Component to scale down all services to zero except for the databases to prepare the instance for the [multi-version-upgrade process](https://docs.sourcegraph.com/admin/deploy/kubernetes/update#multi-version-upgrades).
Hello World
1 change: 1 addition & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,4 @@ kubectl apply --prune -l deploy=sourcegraph -f cluster.yaml
This command will apply all the resources defined in the cluster.yaml file to your cluster, and also remove any resources that are no longer defined in the file.

> NOTE: By default, the kubectl apply command does not remove resources that are no longer defined in the manifests. By adding the --prune flag, you are telling kubectl to remove any resources that are no longer present in the manifests.
Hello World
1 change: 1 addition & 0 deletions examples/aws/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ This overlay:
- sets the provisioner to `kubernetes.io/aws-ebs`.

Use this provisioner when using the `Amazon EBS CSI Driver` as an Amazon EKS add-on
Hello World
1 change: 1 addition & 0 deletions examples/aws/ebs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ This overlay:
- sets the storage class provisioner to `ebs.csi.aws.com`.

Use this overlay when using the **self-managed Amazon EBS Container Storage Interface driver**
Hello World
1 change: 1 addition & 0 deletions examples/base/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ The base overlays are for deploying all Sourcegraph services from the base direc
# NOTE: replace `xs` with your instance size.
kubectl kustomize /examples/base/xs -o cluster.yaml
```
Hello World
2 changes: 1 addition & 1 deletion examples/dev/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

This overlay is intended for Sourcegraph internal CI tests. It removes resource requests including cpu, memory and persistent volumes to reduce load on shared clusters.

Note: `persistentVolumeClaim: null` is needed to avoid https://github.com/kubernetes-sigs/kustomize/issues/2037
Note: `persistentVolumeClaim: null` is needed to avoid https://github.com/kubernetes-sigs/kustomize/issues/2037Hello World
1 change: 1 addition & 0 deletions examples/executors/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ This overlay:

- deploys Sourcegraph without monitoring services
- deploys native kubernetes executors
Hello World
1 change: 1 addition & 0 deletions examples/gke/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# GKE Example Overlay

Deploy Sourcegraph without RBAC resources
Hello World
1 change: 1 addition & 0 deletions examples/gke/default/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
Deploy Sourcegraph with default settings to the default namespace on GKE.
Hello World
1 change: 1 addition & 0 deletions examples/gke/rbac/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
If RBAC is enabled in your cluster, it is strongly recommended to deploy Sourcegraph with full monitoring stack and service-discovery enabled.
Hello World
1 change: 1 addition & 0 deletions examples/ingress-controller/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@
This overlay is for adding resources to deploy a `ingress-nginx-controller` before Sourcegraph. It utilizes the remote build function to get the resources from the official [ingress-nginx-controller repository](https://github.com/kubernetes/ingress-nginx).

See a list of available deployments at https://github.com/kubernetes/ingress-nginx/tree/controller-v1.5.1/deploy/static/provider
Hello World
1 change: 1 addition & 0 deletions examples/k3s/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,4 @@ kubectl kustomize https://github.com/sourcegraph/deploy-sourcegraph-k8s/examples
```

The manifests will be grouped and exported to the cluster.yaml file in the directory where you run the command from.
Hello World
1 change: 1 addition & 0 deletions examples/minikube/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ Overlays to configure a Sourcegraph instance to run in minikube with:
- ./full: Sourcegraph with monitoring stack

See our [Install Sourcegraph with minikube](https://docs.sourcegraph.com/admin/deploy/single-node/minikube) for detailed instructions.
Hello World
1 change: 1 addition & 0 deletions examples/monitoring/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
Deploy the monitoring stacks.

RBAC must be enabled for monitoring services to function properly or empty grafana dashboards are expected.
Hello World
1 change: 1 addition & 0 deletions examples/monitoring/privileged/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
Deploy Sourcegraph monitoring services as root with privileges.

RBAC resouces included.
Hello World
1 change: 1 addition & 0 deletions examples/old-cluster/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@ kubectl kustomize /examples/old-cluster -o cluster.yaml
# To generate manifests for the old base cluster:
kubectl kustomize /examples/old-cluster -o cluster.yaml
```
Hello World
1 change: 1 addition & 0 deletions examples/privileged/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,4 @@ kubectl kustomize https://github.com/sourcegraph/deploy-sourcegraph-k8s/examples
```

The manifests will be grouped and exported to the cluster.yaml file in the directory where you run the command from.
Hello World
1 change: 1 addition & 0 deletions instances/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,4 @@ cp instances/template/buildConfig.template.yaml instances/$INSTANCE_NAME/buildCo
```

**Step 3**: You can begin customizing your Sourcegraph deployment by updating the [kustomization.yaml file](https://docs.sourcegraph.com/admin/deploy/kubernetes/kustomize#kustomization-yaml) inside $INSTANCE_NAME (the directory for your instance). Please follow our [configuration guides](https://docs.sourcegraph.com/admin/deploy/kubernetes/configure) for guidance.
Hello World
Loading