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

Update README #2

Merged
merged 1 commit into from
May 7, 2021
Merged

Update README #2

merged 1 commit into from
May 7, 2021

Conversation

burmanm
Copy link
Contributor

@burmanm burmanm commented Mar 31, 2021

Update to linsk to k8ssandra repositories and k8ssandra docs instead of old Datastax resources

@burmanm burmanm requested a review from bradfordcp March 31, 2021 09:27
Copy link
Member

@bradfordcp bradfordcp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a few comments that are not directly blockers, but it would be nice to get some feedback prior to tossing a 👍 out there.

README.md Outdated Show resolved Hide resolved
README.md Outdated

The DataStax Kubernetes Operator for Apache Cassandra®
The k8ssandra Kubernetes Operator for Apache Cassandra®. This repository replaces the old [datastax/cass-operator](https://github.com/datastax/cass-operator) for use-cases in the k8ssandra project. Some documentation is still out of date and will be modified in the future. Check [k8ssandra/k8ssandra](https://github.com/k8ssandra/k8ssandra) for more up to date information.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The k8ssandra Kubernetes Operator for Apache Cassandra®. This repository replaces the old [datastax/cass-operator](https://github.com/datastax/cass-operator) for use-cases in the k8ssandra project. Some documentation is still out of date and will be modified in the future. Check [k8ssandra/k8ssandra](https://github.com/k8ssandra/k8ssandra) for more up to date information.
The K8ssandra Kubernetes Operator for Apache Cassandra®. This repository replaces the old [datastax/cass-operator](https://github.com/datastax/cass-operator) for use-cases in the k8ssandra project. Some documentation is still out of date and will be modified in the future. Check [k8ssandra/k8ssandra](https://github.com/k8ssandra/k8ssandra) for more up to date information.

A custom Docker registry may be used as the source of the operator Docker image. Before "helm install" is run, a Secret of type "docker-registry" should be created with the proper credentials.

Then the "imagePullSecret" helm value may be set to the name of the ImagePullSecret to cause the custom Docker registry to be used.
To install a cluster with optional integrated backup/restore and repair utilities, check the [k8ssandra/k8ssandra](https://github.com/k8ssandra/k8ssandra) helm charts project.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should have a sentence referencing the full installation of K8ssandra, but still provide guidance on how to install just the cass-operator chart.

Not related to this PR, but interesting nonetheless, do you think there should be a Helm chart that simply templates out a CassandraDatacenter?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not think that there should be a standalone chart to template out a CassandraDatacenter. By doing that you effectively constraint yourself to applying updates only through Helm. If you update the dc outside of Helm and then later run helm upgrade your changes are lost.

@burmanm
Copy link
Contributor Author

burmanm commented May 7, 2021

@johnsmartco Here are the changes for manifests and such.

@burmanm burmanm force-pushed the readme_updates branch 3 times, most recently from 532797f to 7a43e2d Compare May 7, 2021 14:50
Copy link
Contributor

@johnsmartco johnsmartco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@burmanm, thanks for the updates. Other than the product naming question on L4 of README.md, the edits in this PR look ok to me.

…f old Datastax resources

Update manifests to 1.7.0 supported form, remove per-kubernetes-ones

Remove -ver manifest links

Rename back to DataStax Cass Operator
@burmanm burmanm merged commit 9ecee7e into k8ssandra:master May 7, 2021
jdonenine added a commit that referenced this pull request Jun 15, 2021
* Fossa Integration
* Add fossa configuration file generated with `fossa init`
* Add GH action to trigger tooling on pushes to master and on releases

* Add temporary hook for pull_requests for testing

* Split out and update workflows.

* Fix typo

* Restructure yaml

* Fix typo

* Testing

* Disable other workflows for testing

* Restructure

* File will be autogenerated each run.

* Debugging

* More debug

* Remove debug code

* Debug release workflow

* Switch to outputs from env variables

* TEsting

* More debug

* Last test, getting close.

* Final changes.

* Revert test changes to other workflows

* K8 ssand 488  fossa integration (#1)

* Fossa Integration
* Add fossa configuration file generated with `fossa init`
* Add GH action to trigger tooling on pushes to master and on releases

* Add temporary hook for pull_requests for testing

* Split out and update workflows.

* Fix typo

* Restructure yaml

* Fix typo

* Testing

* Disable other workflows for testing

* Restructure

* File will be autogenerated each run.

* Debugging

* More debug

* Remove debug code

* Debug release workflow

* Switch to outputs from env variables

* TEsting

* More debug

* Last test, getting close.

* Final changes.

* Revert test changes to other workflows

* Remove testing on-push

* K8 ssand 488  fossa integration (#2)

* Fossa Integration
* Add fossa configuration file generated with `fossa init`
* Add GH action to trigger tooling on pushes to master and on releases

* Add temporary hook for pull_requests for testing

* Split out and update workflows.

* Fix typo

* Restructure yaml

* Fix typo

* Testing

* Disable other workflows for testing

* Restructure

* File will be autogenerated each run.

* Debugging

* More debug

* Remove debug code

* Debug release workflow

* Switch to outputs from env variables

* TEsting

* More debug

* Last test, getting close.

* Final changes.

* Revert test changes to other workflows

* Remove testing on-push

* Fossa Integration
* Add fossa configuration file generated with `fossa init`
* Add GH action to trigger tooling on pushes to master and on releases

* Add temporary hook for pull_requests for testing

* Split out and update workflows.

* Fix typo

* Restructure yaml

* Fix typo

* Testing

* Disable other workflows for testing

* Restructure

* Debugging

* More debug

* Remove debug code

* Debug release workflow

* Switch to outputs from env variables

* TEsting

* More debug

* Last test, getting close.

* Final changes.

* Revert test changes to other workflows

* Re-enable scanning on PRs

* Remove the release check workflow

* Switch to only on push to better fit the model Fossa exposes.

* Update readme to include link to public scanning report.

* Update changelog

* Include the fossa configuration file in source control instead of generation.

* limit checks to changes in code paths

* Modify so that workflow is triggered on all pushes to master - this keeps the commits in sync between GH and Fossa's reports.
burmanm added a commit to burmanm/cass-operator that referenced this pull request Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants